Skip to content

Commit

Permalink
add changelog and contribution guide, update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Michał Sajnóg committed Jun 19, 2016
1 parent c70831e commit f8de46d
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 38 deletions.
41 changes: 41 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Change Log

## [Unreleased]

### Added
- Add new CHANGELOG
- Add contribution guide
- Add emojis in README
- Add map file for styles

### Changed
- Make `data-aos` attributes the default and only proper ones
- Use maps and loops in Sass
- Replace gulp with webpack
- Rewrite Karma config and use webpack to bundle tests
- Upgrade to ES6
- Update documentation
- Update demos

### Removed
- Remove `aos` attributes
- Remove gulp from build tools

### Fixed
- Improve animations performance
- Fix styles loading in tests

## [1.2.2]
### Fixed
- Fix AOS refreshing on asynchronously loaded elements

## [1.2.1]
### Fixed
- Fix problem with using AOS as node package by setting main file in package.json

## [1.2.0]
### Added
- Add compatibility with module systems

### Fixed
- Fix AOS initializing when DOM is already loaded
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contributing to AOS

## Bugs

Found a bug? Have a problem with AOS? Please check past issues, maybe someone already had that problem. If you don't find similar issue create new, but remember to add accurate informations so that I can dig into it straight away. If it's possible add CodePen example that presents called issue.

## Development process

AOS is built using webpack.

### Setup

- Install all dependencies:

```
npm install
```

- Run dev server:

```
npm run dev
```

This will run local webpack-dev-server and build AOS automatically.

- Open browser and head to:
[http://localhost:8080/webpack-dev-server/](http://localhost:8080/webpack-dev-server/)
Server loads content from `demo` folder.

Now you are ready to play with AOS. Browser should reload automatically as you change code in `src` folder.

### Testing

Before you create Pull Request make sure all tests are passing.

In order to do so run:
```
npm test
```

### Commiting changes

If all tests are passing then you're good to go. Commit your changes, but remember to **not commit `dist` folder**.
Create well described Pull Request with as many informations as possible and wait for my answer :) I'd be happy to make a code review and put some thougths.
45 changes: 7 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# AOS - Animate on scroll library
[![NPM version](https://img.shields.io/npm/v/aos.svg?style=flat)](https://npmjs.org/package/aos)
[![NPM downloads](https://img.shields.io/npm/dm/aos.svg?style=flat)](https://npmjs.org/package/aos)
[![Build Status](https://travis-ci.org/michalsnik/aos.svg?branch=master)](https://travis-ci.org/michalsnik/aos)

Small library to animate elements on your page as you scroll.
Expand All @@ -11,9 +13,8 @@ If you scroll back to top, element will animate to it's previous state and is re
### 🚀 DEMO
[Click here](http://michalsnik.github.io/aos/)

## Requirements

* None -> from version 0.4.x AOS doesn't rely on jQuery anymore
## ❗ Attention
> From version `2.0.0` attributes `aos` are no longer supported, always use `data-aos`.
## ⚙ Setup

Expand Down Expand Up @@ -275,42 +276,10 @@ You can choose one of these timing function to animate elements nicely:
* ease-out-quart
* ease-in-out-quart

## ✌️ Contribution

I use gulp to concatenate JS & CSS and minify it.

First install all gulp dependencies:

```
npm install
```

And run gulp, to start localhost with livereload and tests:

```
gulp
```
## ✌️ Contribution [(click here)](CONTRIBUTION.md)

Now you're ready to roll.
Head into `/demo` in your browser folder to test your code in real environment.
## 📝 Changelog [(click here)](CONTRIBUTION.md)

## ❔Questions

If you have any questions, ideas or whatsoever, please let me know in `issues` or message me directly.
## 📝 Changelog
#### 2.0.0
- Make `data-aos` attributes the default ones
- Improve animations performance
#### 1.2.2
- Fix AOS refreshing on asynchronously loaded elements
#### 1.2.1
- Add main file to package.json
#### 1.2.0
- Add compatibility with module systems
- Improve AOS initializing
If you have any questions, ideas or whatsoever, please check [AOS contribution guide](CONTRIBUTION.md) and don't hesitate to create new a issue.

0 comments on commit f8de46d

Please sign in to comment.