Skip to content

Commit 297f0b3

Browse files
committed
Updated docs
1 parent 8940185 commit 297f0b3

File tree

2 files changed

+30
-29
lines changed

2 files changed

+30
-29
lines changed

DOCUMENTATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Parses a Git url.
1515
#### Return
1616
- **GitUrl** The `GitUrl` object containing:
1717
- `protocols` (Array): An array with the url protocols (usually it has one element).
18-
- `port` (null|Number): The domain port.
18+
- `port` (String): The domain port.
1919
- `resource` (String): The url domain (including subdomains).
2020
- `user` (String): The authentication user (usually for ssh urls).
2121
- `pathname` (String): The url pathname.

README.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ const GitUrlParse = require("git-url-parse");
8282
console.log(GitUrlParse("[email protected]:IonicaBizau/node-git-url-parse.git"));
8383
// => {
8484
// protocols: []
85-
// , port: ""
85+
// , port: null
8686
// , resource: "github.com"
8787
// , user: "git"
8888
// , pathname: "/IonicaBizau/node-git-url-parse.git"
@@ -100,7 +100,7 @@ console.log(GitUrlParse("[email protected]:IonicaBizau/node-git-url-parse.git"));
100100
console.log(GitUrlParse("https://github.com/IonicaBizau/node-git-url-parse.git"));
101101
// => {
102102
// protocols: ["https"]
103-
// , port: ""
103+
// , port: null
104104
// , resource: "github.com"
105105
// , user: ""
106106
// , pathname: "/IonicaBizau/node-git-url-parse.git"
@@ -118,7 +118,7 @@ console.log(GitUrlParse("https://github.com/IonicaBizau/node-git-url-parse.git")
118118
console.log(GitUrlParse("https://github.com/IonicaBizau/git-url-parse/blob/master/test/index.js"));
119119
// { protocols: [ 'https' ],
120120
// protocol: 'https',
121-
// port: "",
121+
// port: null,
122122
// resource: 'github.com',
123123
// user: '',
124124
// pathname: '/IonicaBizau/git-url-parse/blob/master/test/index.js',
@@ -153,23 +153,6 @@ console.log(GitUrlParse("[email protected]:IonicaBizau/node-git-url-parse.git").toS
153153

154154

155155

156-
157-
## :question: Get Help
158-
159-
There are few ways to get help:
160-
161-
162-
163-
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
164-
2. For bug reports and feature requests, open issues. :bug:
165-
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
166-
167-
168-
169-
170-
171-
172-
173156
## :memo: Documentation
174157

175158

@@ -186,7 +169,7 @@ Parses a Git url.
186169
#### Return
187170
- **GitUrl** The `GitUrl` object containing:
188171
- `protocols` (Array): An array with the url protocols (usually it has one element).
189-
- `port` (null|Number): The domain port.
172+
- `port` (String): The domain port.
190173
- `resource` (String): The url domain (including subdomains).
191174
- `user` (String): The authentication user (usually for ssh urls).
192175
- `pathname` (String): The url pathname.
@@ -225,6 +208,24 @@ Stringifies a `GitUrl` object.
225208

226209

227210

211+
## :question: Get Help
212+
213+
There are few ways to get help:
214+
215+
216+
217+
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
218+
2. For bug reports and feature requests, open issues. :bug:
219+
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
220+
221+
222+
223+
224+
225+
226+
227+
228+
228229

229230

230231

@@ -274,6 +275,7 @@ If you are using this library in one of your projects, add it in this list. :spa
274275
- `@1coin178/github-compare`
275276
- `@_nomtek/react-native-shimmer-animation`
276277
- `@adityasinghal26/backstage-plugin-daytona`
278+
- `@ahmed_shaban123/react-native-currencyinput`
277279
- `@akemona-org/strapi-generate-new`
278280
- `@amiruldev/wajs`
279281
- `@anakz/backstage-plugin-library-check-backend`
@@ -321,7 +323,6 @@ If you are using this library in one of your projects, add it in this list. :spa
321323
- `@deskbtm/workspace-tools`
322324
- `@dfatwork-pkgs/backstage-cli`
323325
- `@dougkulak/semantic-release-gh-pages-plugin`
324-
- `@drakedeatonuk/rschedule`
325326
- `@dtwo/telemetry`
326327
- `@eat-fish/changelog`
327328
- `@emedvedev/renovate`
@@ -337,6 +338,7 @@ If you are using this library in one of your projects, add it in this list. :spa
337338
- `@flxbl-io/sfp`
338339
- `@focusworkstemp/project-utils`
339340
- `@form8ion/lift`
341+
- `@gambitnash/cli-plugin-scaffold`
340342
- `@gasket/plugin-metrics`
341343
- `@geut/chan-parser`
342344
- `@geut/git-compare-template`
@@ -432,6 +434,7 @@ If you are using this library in one of your projects, add it in this list. :spa
432434
- `@strapi/pack-up`
433435
- `@strapi/sdk-plugin`
434436
- `@strapi/strapi`
437+
- `@syedt/hellosdk`
435438
- `@tahul/ui-fix`
436439
- `@taingo97/react-native-sunmi-printer`
437440
- `@taingo97/react-native-telpo-printer`
@@ -468,7 +471,6 @@ If you are using this library in one of your projects, add it in this list. :spa
468471
- `biometric-st`
469472
- `bitbucket-pullr`
470473
- `changelog.md`
471-
- `checkbox-component`
472474
- `clipped`
473475
- `codesandbox-theme-docs`
474476
- `common-boilerplate`
@@ -479,12 +481,12 @@ If you are using this library in one of your projects, add it in this list. :spa
479481
- `cz-conventional-changelog-befe`
480482
- `datoit-generate-new`
481483
- `debone`
482-
- `def-core`
483484
- `development-efficiency`
484485
- `docula-ui`
485486
- `docula-ui-express`
486487
- `documentation`
487488
- `documentation-custom-markdown`
489+
- `domaincomponent`
488490
- `dx-scanner`
489491
- `ewizard-cli`
490492
- `fluent.adflow.reactnativesdk-alpha`
@@ -497,8 +499,6 @@ If you are using this library in one of your projects, add it in this list. :spa
497499
- `gatsby-source-git`
498500
- `gatsby-source-git-remotes`
499501
- `gatsby-source-npmjs`
500-
- `gatsby-theme-cone`
501-
- `gatsby-theme-nestx`
502502
- `gatsby-theme-zh`
503503
- `gaurav-react-native-loop`
504504
- `gcpayz-block-sdk`
@@ -507,7 +507,6 @@ If you are using this library in one of your projects, add it in this list. :spa
507507
- `gerimismalamsenin`
508508
- `ghseek`
509509
- `git-issues`
510-
- `git-observer`
511510
- `git-origin-check`
512511
- `git-service-node`
513512
- `git-source`
@@ -535,6 +534,7 @@ If you are using this library in one of your projects, add it in this list. :spa
535534
- `lambda-service`
536535
- `lcov-server`
537536
- `lerna`
537+
- `library-nuxt-ui`
538538
- `license-analysis`
539539
- `lime-cli`
540540
- `manage-dependency`
@@ -549,6 +549,7 @@ If you are using this library in one of your projects, add it in this list. :spa
549549
- `npm_one_1_2_3`
550550
- `npm_qwerty`
551551
- `octokit-downloader`
552+
- `octopulse`
552553
- `omg`
553554
- `open-pull-request`
554555
- `package-health-checker`
@@ -591,6 +592,7 @@ If you are using this library in one of your projects, add it in this list. :spa
591592
- `react-native-dhp-printer`
592593
- `react-native-fedlight-dsm`
593594
- `react-native-ghn-ekyc`
595+
- `react-native-ideo-rn-notifications`
594596
- `react-native-innity-remaster`
595597
- `react-native-input-library`
596598
- `react-native-is7`
@@ -619,7 +621,6 @@ If you are using this library in one of your projects, add it in this list. :spa
619621
- `react-native-shared-gesture`
620622
- `react-native-test-comlibrary`
621623
- `react-native-ticker-tape`
622-
- `react-native-tone-test`
623624
- `react-native-uvc-camera-android`
624625
- `react-native-withframework-check`
625626
- `react-native-ytximkit`

0 commit comments

Comments
 (0)