Merge pull request #5 from EDITD/add-contributing

Add contributing

Author: braposo

CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## v1.0.0
+- First public release

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing
+
+We are open to, and grateful for, any contributions made by the community.
+
+## Reporting Issues
+
+Before opening an issue, please search the [issue tracker](https://github.com/EDITD/react-text-loop/issues) to make sure your issue hasn't already been reported.
+
+## Development
+
+Visit the [Issue tracker](https://github.com/EDITD/react-text-loop/issues) to find a list of open issues that need attention.
+
+Fork, then clone the repo:
+```
+git clone https://github.com/your-username/react-text-loop.git
+```
+
+Build package for dev mode. It will automatically watch any changes in `src/` forlder:
+```
+yarn run dev
+```
+
+We follow [eslint-config-edited](https://www.npmjs.com/package/eslint-config-edited) for code style.
+
+### Building and testing
+
+Build package:
+```
+yarn run build
+```
+
+To run the tests:
+```
+npm run test
+```
+
+To perform linting with `eslint`, run the following:
+```
+npm run lint
+```
+
+### New Features
+
+Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.
+
+## Submitting Changes
+
+* Open a new issue in the [Issue tracker](https://github.com/EDITD/react-text-loop/issues).
+* Fork the repo.
+* Create a new feature branch based off the `master` branch.
+* Make sure all tests pass and there are no linting errors.
+* Submit a pull request, referencing any issues it addresses.
+
+Please try to keep your pull request focused in scope and avoid including unrelated commits.
+
+After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.
+
+Thank you for contributing!

README.md

@@ -13,8 +13,6 @@ An animated loop of text nodes for your headings. Uses [react-motion](https://gi
 
 ### Code
 
-Example:
-
 ```jsx
 import TextLoop from 'react-text-loop';
 
@@ -98,7 +96,7 @@ You can also just send a normal array as children prop if you don't need any ind
 
 ## Contributing
 
-Please follow our contributing guidelines.
+Please follow our [contributing guidelines](https://github.com/EDITD/react-text-loop/blob/master/CONTRIBUTING.md).
 
 ## License
 

package.json

@@ -16,10 +16,13 @@
     "url": "git+https://github.com/EDITD/react-text-loop.git"
   },
   "keywords": [
+    "react",
+    "component",
     "text",
-    "animated",
+    "animation",
     "loop",
     "cycle",
+    "react",
     "motion"
   ],
   "author": {