From bcaf9ea0d2c3b70924e0fd5149f65b7a548605ff Mon Sep 17 00:00:00 2001
From: osher <osher.filter@gmail.com>
Date: Mon, 20 Dec 2021 18:28:50 +0200
Subject: [PATCH] Update README.md

yada yada applitools etc.
---
 packages/npm-next-version/README.md | 22 +++++++++++++---------
 1 file changed, 13 insertions(+), 9 deletions(-)

diff --git a/packages/npm-next-version/README.md b/packages/npm-next-version/README.md
index 9f958f2c..26d7730b 100644
--- a/packages/npm-next-version/README.md
+++ b/packages/npm-next-version/README.md
@@ -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.