Skip to content

Commit 252b716

Browse files
committed
Updated docs
1 parent 44ddaa2 commit 252b716

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

DOCUMENTATION.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,15 @@
22

33
You can see below the API reference of this module.
44

5-
### `gitUrlParse(url)`
5+
### `gitUrlParse(url, refs)`
66
Parses a Git url.
77

88
#### Params
99

1010
- **String** `url`: The Git url to parse.
11+
- **Array** `refs`: An array of strings representing the refs. This is helpful in the context of the URLs that contain branches with slashes.
12+
If user wants to identify the branch, he should pass all branch names
13+
of the project as part of refs parameter
1114

1215
#### Return
1316
- **GitUrl** The `GitUrl` object containing:

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,12 +173,15 @@ There are few ways to get help:
173173
## :memo: Documentation
174174

175175

176-
### `gitUrlParse(url)`
176+
### `gitUrlParse(url, refs)`
177177
Parses a Git url.
178178

179179
#### Params
180180

181181
- **String** `url`: The Git url to parse.
182+
- **Array** `refs`: An array of strings representing the refs. This is helpful in the context of the URLs that contain branches with slashes.
183+
If user wants to identify the branch, he should pass all branch names
184+
of the project as part of refs parameter
182185

183186
#### Return
184187
- **GitUrl** The `GitUrl` object containing:
@@ -368,10 +371,11 @@ If you are using this library in one of your projects, add it in this list. :spa
368371
- `@monokle/synchronizer`
369372
- `@narfeta/catalog-backend`
370373
- `@navabi/react-native-ssl-pinning`
374+
- `@npm_fluentco/adflow-react-native-sdk`
371375
- `@nuxt/telemetry`
372376
- `@nuxt/ui-pro`
373377
- `@nuxthq/studio`
374-
- `@oiti/rn-liveness2d`
378+
- `@oumi/block-sdk`
375379
- `@oumi/cli-ui`
376380
- `@pageshare/cli`
377381
- `@parallelnft/web3modal`
@@ -417,6 +421,7 @@ If you are using this library in one of your projects, add it in this list. :spa
417421
- `@storybook/storybook-deployer`
418422
- `@strapi/pack-up`
419423
- `@strapi/strapi`
424+
- `@tahul/ui-fix`
420425
- `@taingo97/react-native-rsa-expo`
421426
- `@taingo97/react-native-sunmi-printer`
422427
- `@taingo97/react-native-telpo-printer`
@@ -509,7 +514,6 @@ If you are using this library in one of your projects, add it in this list. :spa
509514
- `github-assistant`
510515
- `github-publish-npm`
511516
- `gitlab-ci-variables-cli`
512-
- `griffin-ui-library`
513517
- `gtni`
514518
- `harry-reporter`
515519
- `hzero-block-sdk`
@@ -583,6 +587,7 @@ If you are using this library in one of your projects, add it in this list. :spa
583587
- `react-native-custom-poccomponent`
584588
- `react-native-dhp-printer`
585589
- `react-native-fedlight-dsm`
590+
- `react-native-flyy`
586591
- `react-native-ghn-ekyc`
587592
- `react-native-innity-remaster`
588593
- `react-native-input-library`
@@ -602,7 +607,6 @@ If you are using this library in one of your projects, add it in this list. :spa
602607
- `react-native-multiselector`
603608
- `react-native-my-first-try-arun-ramya`
604609
- `react-native-nice-learning`
605-
- `react-native-package-demo-yash-tech`
606610
- `react-native-paynow-generator`
607611
- `react-native-payu-payment-testing`
608612
- `react-native-progress-arrow`

0 commit comments

Comments
 (0)