Skip to content

Update README.md #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
osher wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions packages/npm-next-version/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,33 @@
# npm-next-version

Library that yada yada yada.
Find next version for a package.

## Installing

```sh
npm install @applitools/npm-next-version
npm install @built/npm-next-version
```

## Using the package

* yada yada yada
The package is used internally in `built`.

```js
const yadayada = require('@applitools/npm-next-version')
const npmNextVersion = require('@built/npm-next-version')

const { name, version } = require(packageDirectory);

const nextVersion = await npmNextVersion({version, name, packageDirectory});

yada yada yada
```

## API

```js
yadaYada(yada)
npmNextVersion({version, name, packageDirectory})
```

* `yada`: yada yada
* `version`: the current version of the package
* `name`: the name of the version as it appears in `package.json`
* `packageDirectory`: path to the directory of the directory where `package.json` should be found

* Returns: yada yada yada
* Returns: string of the next avbailable semver version.