📝 Documentation

Author: IonicaBizau

CONTRIBUTING.md

@@ -6,7 +6,7 @@ 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],
+ - 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
    other ideas you have. This will help us to get you started on the right
    foot.
@@ -57,4 +57,5 @@ Finally, your contributions will be merged, and everyone will be happy! :smile:
 Thanks! :sweat_smile:
 
 [1]: https://github.com/IonicaBizau/node-git-url-parse/issues
+
 [2]: https://github.com/IonicaBizau/code-style

README.md

@@ -17,7 +17,7 @@
 
 # git-url-parse [![Donate now][donate-now]][paypal-donations]
 
-Parses and stringifies git urls.
+A high level git url parser for common git providers.
 
 ## Installation
 
@@ -32,26 +32,46 @@ $ npm i git-url-parse
 var GitUrlParse = require("git-url-parse");
 
 console.log(GitUrlParse("[email protected]:IonicaBizau/node-git-url-parse.git"));
-// => { protocol: 'ssh'
-//    , source: 'github.com'
-//    , owner: 'IonicaBizau'
-//    , name: 'node-git-url-parse'
-//    , _: '[email protected]:IonicaBizau/node-git-url-parse.git'
-//    , toString: [Function] }
+// => {
+//     protocols: []
+//   , port: null
+//   , resource: "github.com"
+//   , user: "git"
+//   , pathname: "/IonicaBizau/node-git-url-parse.git"
+//   , hash: ""
+//   , search: ""
+//   , href: "[email protected]:IonicaBizau/node-git-url-parse.git"
+//   , token: ""
+//   , protocol: "ssh"
+//   , toString: [Function]
+//   , source: "github.com"
+//   , name: "node-git-url-parse"
+//   , owner: "IonicaBizau"
+// } {
 
 console.log(GitUrlParse("https://github.com/IonicaBizau/node-git-url-parse.git"));
-// => { protocol: 'https'
-//    , source: 'github.com'
-//    , owner: 'IonicaBizau'
-//    , name: 'node-git-url-parse'
-//    , _: 'https://github.com/IonicaBizau/node-git-url-parse.git'
-//    , toString: [Function] }
+// => {
+//     protocols: ["https"]
+//   , port: null
+//   , resource: "github.com"
+//   , user: ""
+//   , pathname: "/IonicaBizau/node-git-url-parse.git"
+//   , hash: ""
+//   , search: ""
+//   , href: "https://github.com/IonicaBizau/node-git-url-parse.git"
+//   , token: ""
+//   , protocol: "https"
+//   , toString: [Function]
+//   , source: "github.com"
+//   , name: "node-git-url-parse"
+//   , owner: "IonicaBizau"
+// }
 
 console.log(GitUrlParse("https://github.com/IonicaBizau/node-git-url-parse.git").toString("ssh"));
-// => '[email protected]:IonicaBizau/node-git-url-parse.git.git'
+// => "[email protected]:IonicaBizau/node-git-url-parse.git"
 
 console.log(GitUrlParse("[email protected]:IonicaBizau/node-git-url-parse.git").toString("https"));
-// => 'https://github.com/IonicaBizau/node-git-url-parse.git'
+// => "https://github.com/IonicaBizau/node-git-url-parse.git"
 
 ```
 
@@ -65,12 +85,21 @@ Parses a Git url.
 
 #### Return
 - **GitUrl** The `GitUrl` object containing:
- - `protocol` (String): The url protocol.
+ - `protocols` (Array): An array with the url protocols (usually it has one element).
+ - `port` (null|Number): The domain port.
+ - `resource` (String): The url domain (including subdomains).
+ - `user` (String): The authentication user (usually for ssh urls).
+ - `pathname` (String): The url pathname.
+ - `hash` (String): The url hash.
+ - `search` (String): The url querystring value.
+ - `href` (String): The input url.
+ - `protocol` (String): The git url protocol.
+ - `token` (String): The oauth token (could appear in the https urls).
  - `source` (String): The Git provider (e.g. `"github.com"`).
  - `owner` (String): The repository owner.
  - `name` (String): The repository name.
- - `_` (String): The original url which was parsed.
  - `toString` (Function): A function to stringify the parsed url into another url type.
+ - `organization` (String): The organization the owner belongs to. This is CloudForge specific.
 
 ### `stringify(obj, type)`
 Stringifies a `GitUrl` object.