diff --git a/Contributing.md b/Contributing.md index 2405ca1..0d27d3f 100644 --- a/Contributing.md +++ b/Contributing.md @@ -6,7 +6,7 @@ I love pull requests. And following this simple guidelines will make your pull r ## Submitting pull requests 1. Create a new branch, please don’t work in master directly. -2. Add failing tests (if there’re any tests in project) for the change you want to make. Run tests (usually `grunt` or `npm test`) to see the tests fail. +2. Add failing tests (if there’re any tests in project) for the change you want to make. Run tests (see below) to see the tests fail. 3. Hack on. 4. Run tests to see if the tests pass. Repeat steps 2–4 until done. 5. Update the documentation to reflect any changes. @@ -60,13 +60,14 @@ function foo(bar, fum) { - Feel free to [ask me](http://sapegin.me/contacts) anything you need. -## How to build / test +## Building and running tests `cd` to `src` folder first. Install dependencies: ```bash +npm install grunt-cli -g npm install ``` @@ -76,7 +77,7 @@ Hack on: grunt watch ``` -Build: +Build / run tests: ```bash grunt diff --git a/Readme.md b/Readme.md index d5a2a26..6e9ef72 100644 --- a/Readme.md +++ b/Readme.md @@ -3,13 +3,13 @@ [![Bower version](https://badge.fury.io/bo/social-likes.png)](http://badge.fury.io/bo/social-likes) [![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/) -Beautiful “like” buttons with counters for popular social networks: Facebook, Twitter, LiveJournal, etc. Uses jQuery. +Beautiful share buttons with counters for popular social networks: Facebook, Twitter, Google+, Pinterest, Vkontakte, etc. Uses jQuery. ## Features - Easy to install. -- Beautiful and all in one style. +- Beautiful and all in one style (with three different skins). - Won’t explode your page’s layout. @@ -19,6 +19,7 @@ Use [interactive builder](http://sapegin.github.io/social-likes/) to generate th Or install via [Bower](http://bower.io/): `$ bower install social-likes`. + ## Advanced configuration ### Layout @@ -28,10 +29,10 @@ Or install via [Bower](http://bower.io/): `$ bower install social-likes`. All buttons in a row. ``` -