summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVladislav Zarakovsky <vlad.zar@gmail.com>2016-02-18 11:42:30 +0300
committerVladislav Zarakovsky <vlad.zar@gmail.com>2016-02-18 11:42:30 +0300
commit356b6d66e4f472f6b688c702e95dedeaf2b75c39 (patch)
tree862c5bfc92af072814bb68bdf35d3a77dec27b9d
parentdfd16c9397d9885a8fbc12ebeb1500bca9fd2da1 (diff)
downloadawesomplete-356b6d66e4f472f6b688c702e95dedeaf2b75c39.zip
awesomplete-356b6d66e4f472f6b688c702e95dedeaf2b75c39.tar.gz
awesomplete-356b6d66e4f472f6b688c702e95dedeaf2b75c39.tar.bz2
Extract CONTRIBUTING.md to utilize a new GitHub feature
Setting guidelines for repository contributors https://help.github.com/articles/setting-guidelines-for-repository-contributors/ > To help your project contributors do good work, you can add a file with contribution guidelines to the root of your project's repository. Then, whenever someone opens a pull request or creates an issue, they will see a link to that file.
-rw-r--r--CONTRIBUTING.md52
-rw-r--r--README.md53
2 files changed, 52 insertions, 53 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..3d14f21
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,52 @@
+##Contributing
+
+**Prerequisites**
+
+Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/). On OSX with [Homebrew](http://brew.sh/) installed it is as easy as:
+```
+brew install node
+```
+
+Install dependencies:
+```
+npm install
+```
+
+**Running tests**
+
+Run tests once and exit:
+```
+npm test
+```
+
+Continuous mode. Whenever any source or test file changes, tests will run automatically:
+```
+karma start
+```
+
+Chrome starts automatically and stops on ```Ctrl+C```. You can also open ```http://localhost:9876/``` in any other browser and it will run the tests as long as the tab is open.
+
+**Adding a test**
+
+[Jasmine](http://jasmine.github.io/) is the testing framework used by Awesomplete.
+
+To write a test (or suite of tests) start by adding a `describe` function which receives a string describing what is being tested and a function containing what you expect the test to do. Inside the function use the `it` block to arrange and assert a functionality.
+
+A test would look like this:
+
+```javascript
+describe("A fact", function(){
+ it("is always true",function(){
+ var fact = true;
+ expect(fact).toBe(true);
+ });
+});
+```
+
+See existing tests in ```test``` directory as an example. More expectations and examples on how to use Jasmine can be found on the official [documentation](http://jasmine.github.io/2.2/introduction.html).
+
+**Build minified version**
+
+```
+gulp
+```
diff --git a/README.md b/README.md
index 7aede2d..a4113f1 100644
--- a/README.md
+++ b/README.md
@@ -60,59 +60,6 @@ Or the following, if you don’t want to use a `<datalist>`, or if you don’t w
There are multiple customizations and properties able to be instantiated within the JS. Libraries and definitions of the properties are available in the Links below.
-##Contributing
-
-**Prerequisites**
-
-Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/). On OSX with [Homebrew](http://brew.sh/) installed it is as easy as:
-```
-brew install node
-```
-
-Install dependencies:
-```
-npm install
-```
-
-**Running tests**
-
-Run tests once and exit:
-```
-npm test
-```
-
-Continuous mode. Whenever any source or test file changes, tests will run automatically:
-```
-karma start
-```
-
-Chrome starts automatically and stops on ```Ctrl+C```. You can also open ```http://localhost:9876/``` in any other browser and it will run the tests as long as the tab is open.
-
-**Adding a test**
-
-[Jasmine](http://jasmine.github.io/) is the testing framework used by Awesomplete.
-
-To write a test (or suite of tests) start by adding a `describe` function which receives a string describing what is being tested and a function containing what you expect the test to do. Inside the function use the `it` block to arrange and assert a functionality.
-
-A test would look like this:
-
-```javascript
-describe("A fact", function(){
- it("is always true",function(){
- var fact = true;
- expect(fact).toBe(true);
- });
-});
-```
-
-See existing tests in ```test``` directory as an example. More expectations and examples on how to use Jasmine can be found on the official [documentation](http://jasmine.github.io/2.2/introduction.html).
-
-**Build minified version**
-
-```
-gulp
-```
-
## License
Awesomplete is released under the MIT License. See [LICENSE][1] file for