From 6b93ef81952f3ea543d3dc5a52af5d3c79d47e7d Mon Sep 17 00:00:00 2001 From: Andrew Goldis Date: Mon, 6 Nov 2023 23:55:24 -0800 Subject: [PATCH] chore: update READE< --- README.md | 25 +++++++------------------ 1 file changed, 7 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 60c08ea..a31a0ad 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ -# @cypress/commit-info +# @currents/commit-info > Collects Git commit info from git CLI -[![NPM][npm-icon] ][npm-url] - [![Build status][ci-image] ][ci-url] [![semantic-release][semantic-image] ][semantic-url] [![js-standard-style][standard-image]][standard-url] @@ -14,13 +12,13 @@ Requires [Node](https://nodejs.org/en/) version 6 or above. ```sh -npm install --save @cypress/commit-info +npm install --save @currents-dev/commit-info ``` ## Use ```js -const {commitInfo} = require('@cypress/commit-info') +const {commitInfo} = require('@currents-dev/commit-info') // default folder is current working directory commitInfo(folder) .then(info => { @@ -78,7 +76,7 @@ methods `getBranch`, `getMessage`, `getEmail`, `getAuthor`, `getSha`, `getTimest For example ```js -const {getAuthor} = require('@cypress/commit-info') +const {getAuthor} = require('@currents/commit-info') getAuthor('path/to/repo') .then(name => ...) ``` @@ -88,7 +86,7 @@ getAuthor('path/to/repo') Resolves with the current git branch name or `null`. ```js -const {getBranch} = require('@cypress/commit-info') +const {getBranch} = require('@currents/commit-info') getBranch() .then(branch => ...) ``` @@ -100,7 +98,7 @@ getBranch() License: MIT - do anything with the code, but don't blame me if it does not work. Support: if you find any problems with this module, email / tweet / -[open issue](https://github.com/cypress-io/commit-info/issues) on Github +[open issue](https://github.com/currents-dev/commit-info/issues) on Github ## MIT License @@ -127,13 +125,4 @@ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -[npm-icon]: https://nodei.co/npm/@cypress/commit-info.svg?downloads=true -[npm-url]: https://npmjs.org/package/@cypress/commit-info -[ci-image]: https://github.com/cypress-io/commit-info/actions/workflows/main.yml/badge.svg -[ci-url]: https://github.com/cypress-io/commit-info/actions/workflows/main.yml -[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg -[semantic-url]: https://github.com/semantic-release/semantic-release -[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg -[standard-url]: http://standardjs.com/ -[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg -[renovate-app]: https://renovateapp.com/ +