📝

IonicaBizau · Nov 10, 2015 · c04e2ef · c04e2ef
1 parent 6a05893
commit c04e2ef
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 37 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,17 +6,18 @@ make the life easier and will avoid wasting time on things which are not
 requested. :sparkles:
 
 ## Discuss the changes before doing them
- - First of all, open an issue in the repository, using the [bug tracker][1]
-   describing the contribution you'd like to make, the bug you found or any
+ - First of all, open an issue in the repository, using the [bug tracker][1],
+   describing the contribution you would like to make, the bug you found or any
    other ideas you have. This will help us to get you started on the right
    foot.
 
  - If it makes sense, add the platform and software information (e.g. operating
-   system, Node.JS version etc), screenshots (so we can see what you're seeing).
+   system, Node.JS version etc.), screenshots (so we can see what you are
+   seeing).
 
- - It's recommended to wait for feedback before continuing to next steps. However,
-   if the issue is clear (e.g. a typo) and the fix is simple, you can continue
-   and fix it.
+ - It is recommended to wait for feedback before continuing to next steps.
+   However, if the issue is clear (e.g. a typo) and the fix is simple, you can
+   continue and fix it.
 
 ## Fixing issues
  - Fork the project in your account and create a branch with your fix:
@@ -26,25 +27,26 @@ requested. :sparkles:
    [code style][2]. If the project contains tests (generally, the `test`
    directory), you are encouraged to add a test as well. :memo:
 
- - If the project contains a `package.json` file add yourself in the
-   `contributors` array (if it doesn't exist, create it):
+ - If the project contains a `package.json` or a `bower.json` file add yourself
+   in the `contributors` array (or `authors` in the case of `bower.json`;
+   if the array does not exist, create it):
 
    ```json
    {
       "contributors": [
-         "Your Name <and@email.address> (http://your.website)
+         "Your Name <and@email.address> (http://your.website)"
       ]
    }
    ```
 
 ## Creating a pull request
 
  - Open a pull request, and reference the initial issue in the pull request
-   message (e.g. *fixes #<your-issue-number*). Write a good description and
+   message (e.g. *fixes #<your-issue-number>*). Write a good description and
    title, so everybody will know what is fixed/improved.
 
- - If it makes sense, add screenshots, gifs etc, so it's easier to see what's
-   going on.
+ - If it makes sense, add screenshots, gifs etc., so it is easier to see what
+   is going on.
 
 ## Wait for feedback
 Before accepting your contributions, we will review them. You may get feedback
@@ -53,6 +55,7 @@ in your branch and the pull request will be updated automatically.
 
 ## Everyone is happy!
 Finally, your contributions will be merged, and everyone will be happy! :smile:
+Contributions are more than welcome!
 
 Thanks! :sweat_smile:
 

diff --git a/README.md b/README.md
@@ -1,19 +1,4 @@
-<!---------------------------------------------------------------------------->
-<!-- STOP, LOOK & LISTEN!                                                   -->
-<!-- ====================                                                   -->
-<!-- Do NOT edit this file directly since it's generated from a template    -->
-<!-- file, using https://github.com/IonicaBizau/node-blah                   -->
-<!--                                                                        -->
-<!-- If you found a typo in documentation, fix it in the source files       -->
-<!-- (`lib/*.js`) and make a pull request.                                  -->
-<!--                                                                        -->
-<!-- If you have any other ideas, open an issue.                            -->
-<!--                                                                        -->
-<!-- Please consider reading the contribution steps (CONTRIBUTING.md).      -->
-<!-- * * * Thanks! * * *                                                    -->
-<!---------------------------------------------------------------------------->
-
-# git-up [![Donate now][donate-now]][paypal-donations]
+# git-up [![Support this project][donate-now]][paypal-donations]
 
 A low level git url parser.
 
@@ -54,7 +39,6 @@ console.log(GitUp("https://github.com/IonicaBizau/node-parse-url.git"));
 //   , href: "https://github.com/IonicaBizau/node-parse-url.git"
 //   , protocol: "https"
 // }
-
 ```
 
 ## Documentation
@@ -81,13 +65,20 @@ Parses the input url.
 ## How to contribute
 Have an idea? Found a bug? See [how to contribute][contributing].
 
+## Where is this library used?
+If you are using this library in one of your projects, add it in this list. :sparkles:
+
+ - [`git-url-parse`](https://github.com/IonicaBizau/node-git-url-parse)
+
 ## License
-[KINDLY][license] © [Ionică Bizău][website]–The [LICENSE](/LICENSE) file contains
-a copy of the license.
+
+[KINDLY][license] © [Ionică Bizău][website]
 
 [license]: http://ionicabizau.github.io/kindly-license/?author=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica@gmail.com%3E&year=2015
-[contributing]: /CONTRIBUTING.md
+
 [website]: http://ionicabizau.net
-[docs]: /DOCUMENTATION.md
-[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MG98D7NPFZ3MG
-[donate-now]: http://i.imgur.com/jioicaN.png
+[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
+[donate-now]: http://i.imgur.com/6cMbHOC.png
+
+[contributing]: /CONTRIBUTING.md
+[docs]: /DOCUMENTATION.md
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "git-up",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A low level git url parser.",
   "main": "lib/index.js",
   "directories": {
@@ -33,4 +33,4 @@
   "devDependencies": {
     "mocha": "^2.2.5"
   }
-}
+}