Updated docs

Author: IonicaBizau

DOCUMENTATION.md

@@ -24,6 +24,9 @@ Parses a Git url.
  - `source` (String): The Git provider (e.g. `"github.com"`).
  - `owner` (String): The repository owner.
  - `name` (String): The repository name.
+ - `ref` (String): The repository ref (e.g., "master" or "dev").
+ - `filepath` (String): A filepath relative to the repository root.
+ - `filepathtype` (String): The type of filepath in the url ("blob" or "tree").
  - `full_name` (String): The owner and name values in the `owner/name` format.
  - `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.

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-17 Ionică Bizău <[email protected]> (https://ionicabizau.net)
+Copyright (c) 2015-18 Ionică Bizău <[email protected]> (https://ionicabizau.net)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -64,6 +64,27 @@ console.log(GitUrlParse("https://github.com/IonicaBizau/node-git-url-parse.git")
 //   , owner: "IonicaBizau"
 // }
 
+console.log(GitUrlParse("https://github.com/IonicaBizau/git-url-parse/blob/master/test/index.js"));
+// { protocols: [ 'https' ],
+//   protocol: 'https',
+//   port: null,
+//   resource: 'github.com',
+//   user: '',
+//   pathname: '/IonicaBizau/git-url-parse/blob/master/test/index.js',
+//   hash: '',
+//   search: '',
+//   href: 'https://github.com/IonicaBizau/git-url-parse/blob/master/test/index.js',
+//   token: '',
+//   toString: [Function],
+//   source: 'github.com',
+//   name: 'git-url-parse',
+//   owner: 'IonicaBizau',
+//   organization: '',
+//   ref: 'master',
+//   filepathtype: 'blob',
+//   filepath: 'test/index.js',
+//   full_name: 'IonicaBizau/git-url-parse' }
+
 console.log(GitUrlParse("https://github.com/IonicaBizau/node-git-url-parse.git").toString("ssh"));
 // => "[email protected]:IonicaBizau/node-git-url-parse.git"
 
@@ -109,6 +130,9 @@ Parses a Git url.
  - `source` (String): The Git provider (e.g. `"github.com"`).
  - `owner` (String): The repository owner.
  - `name` (String): The repository name.
+ - `ref` (String): The repository ref (e.g., "master" or "dev").
+ - `filepath` (String): A filepath relative to the repository root.
+ - `filepathtype` (String): The type of filepath in the url ("blob" or "tree").
  - `full_name` (String): The owner and name values in the `owner/name` format.
  - `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.
@@ -137,6 +161,7 @@ this takes time. You can integrate and use these projects in your applications *
 
 However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
 
+
  - Starring and sharing the projects you like :rocket:
  - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
  - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
@@ -145,6 +170,7 @@ However, if you get some profit from this or just want to encourage me to contin
 
     ![](https://i.imgur.com/z6OQI95.png)
 
+
 Thanks! :heart:
 
 
@@ -171,6 +197,7 @@ If you are using this library in one of your projects, add it in this list. :spa
  - [`generator-clearphp`](https://github.com/jkphl/generator-clearphp#readme) (by Joschi Kuphal)—Scaffold for Composer based PHP projects with a lot of integrations, advocating the use of The Clear Architecture (https://jkphl.is/articles/clear-architecture-php)
  - [`generator-nm-bti`](https://gitlab.com/beneaththeink/generator-nm-bti#README) (by Tyler Johnson)—Scaffold out a node module, Beneath the Ink style.
  - [`generator-openapi-repo`](https://github.com/rebilly/generator-openapi-repo#readme) (by Roman Hotsiy)—Yeoman generator for OpenAPI(fka Swagger) repo to help you share spec for your API
+ - [`git-cherry-fix`](https://npmjs.com/package/git-cherry-fix)—> helps you get your fixes to another branch by cherry-picking them
  - [`git-issues`](https://github.com/softwarescales/git-issues) (by Gabriel Petrovay)—Git issues extension to list issues of a Git project
  - [`git-lab-cli`](https://npmjs.com/package/git-lab-cli)—gitlab-cli ==================
  - [`git-signed`](https://github.com/Wizcorp/git-signed#readme) (by Marc Trudel)—git commit signing made easy (and enforceable)
@@ -180,8 +207,10 @@ If you are using this library in one of your projects, add it in this list. :spa
  - [`gitbook-start-iaas-ull-es-alex-moi`](https://github.com/ULL-ESIT-SYTW-1617/gitbook-start-iaas-ull-es-alex-moi.git#readme) (by Moises Yanes Carballo)—Plugin deploy maquina iaas-ull-es
  - [`gitbook-start-iaas-ull-es-merquililycony`](https://github.com/ULL-ESIT-SYTW-1617/gitbook-start-iaas-ull-es-merquililycony#readme) (by Constanza León, Merquis Cruz, Liliana Galiano)—*El objetivo de esta práctica es extender el package NodeJS publicado en npm en una práctica anterior con una nueva* *funcionalidad que permita que los usuarios realizar un despliegue automatico en el servidor de IAAS*
  - [`gitbook-start-plugin-iaas-ull-es-noejaco2017`](http://creacion-de-paquetes-y-modulos-en-nodejs-noejaco2017/README.md) (by alu0100622492)—Despliegue plugin Iaas
+ - [`gitc`](https://github.com/cezarlz/gitc#readme) (by Cezar Luiz)—Manage your pull requests and issues from your command line.
  - [`github-publish-npm`](https://github.com/ofersadgat/github-publish-npm) (by Ofer Sadgat)—This will upload publish npm assets to the GitHub Releases API.
  - [`gitlab-ci-variables-setter-cli`](https://github.com/temando/gitlab-ci-variables-cli#readme) (by Khoa Tran)—CLI tool to allow setting multiple pipeline variables on Gitlab CI.
+ - [`gitline`](https://github.com/cezarlz/gitline#readme) (by Cezar Luiz)—Manage your pull requests and issues from your command line.
  - [`gtni`](https://nmrony.github.io/gtni) (by Nur Mohammed Rony)—Install your all npm dependencies recursively with gtni while you are doing git clone, fetch or pull
  - [`lcov-server`](https://github.com/gabrielcsapo/lcov-server#readme) (by Gabriel J. Csapo)—🎯 A simple lcov server & cli parser
  - [`moto-connector`](https://npmjs.com/package/moto-connector) (by limingv5)—FEB平台SDK
@@ -200,14 +229,15 @@ If you are using this library in one of your projects, add it in this list. :spa
 
 [MIT][license] © [Ionică Bizău][website]
 
-[badge_patreon]: http://ionicabizau.github.io/badges/patreon.svg
-[badge_amazon]: http://ionicabizau.github.io/badges/amazon.svg
-[badge_paypal]: http://ionicabizau.github.io/badges/paypal.svg
-[badge_paypal_donate]: http://ionicabizau.github.io/badges/paypal_donate.svg
+
+[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
+[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
+[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
+[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
+
 [patreon]: https://www.patreon.com/ionicabizau
 [amazon]: http://amzn.eu/hRo9sIZ
 [paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
-[donate-now]: http://i.imgur.com/6cMbHOC.png
 
 [license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit
 [website]: https://ionicabizau.net

package.json

@@ -52,4 +52,4 @@
     "bloggify.json",
     "bloggify/"
   ]
-}
+}