Skip to content

Commit

Permalink
chore: update READE<
Browse files Browse the repository at this point in the history
  • Loading branch information
agoldis committed Nov 7, 2023
1 parent 5aacdd8 commit 6b93ef8
Showing 1 changed file with 7 additions and 18 deletions.
25 changes: 7 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -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]
Expand All @@ -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 => {
Expand Down Expand Up @@ -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 => ...)
```
Expand All @@ -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 => ...)
```
Expand All @@ -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

Expand All @@ -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/

0 comments on commit 6b93ef8

Please sign in to comment.