@ossmo/client - npm Package Compare versions

Comparing version 1.0.7 to 1.0.8

package.json

 {
   "name": "@ossmo/client",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Mine cryptocurrency to support open source sorftware projects.",
@@ -21,6 +21,6 @@ "author": {
   "dependencies": {
-    "@ossmo/my-multi-miner": "^1.0.7",
+    "@ossmo/my-multi-miner": "^1.0.8",
     "enquirer": "^2.3.0"
   },
-  "gitHead": "6fdcde5da5f36c39e9f7707dc37cb0a2ec983bcd"
+  "gitHead": "1a210140ea72fa075e1bad8a25dd52e9aab37818"
 }

README.md

@@ -1,7 +0,25 @@
-# `ossmo-client`
+# @ossmo/client
 
-Prompts the user.
-Installs mining software.
-Begins mining.
+![Screen Recording](https://gitlab.com/jbeard4/ossmo/raw/master/packages/client/screen-recording.gif "Screen Recording")
 
-## Usage
+This package prompts the user, installs mining software, and begins mining.
+
+## API
+
+
+```js
+function promptUser(packageName): Promise
+```
+
+## Example
+
+```js
+module.exports = async function myModuleEntryPoint(){
+  await require('@ossmo/client')(require('./package.json').name);     //here's how you load ossmo
+                                                                      //the prompts are asynchronous,
+                                                                      //so you need to await
+
+  console.log('Do some stuff here');
+}
+```
+

No alert changes

Improved metrics

Total package byte prevSize

239836

increased by1054.17%

Number of package files

8

increased by33.33%

Number of lines in readme file

26

increased by225%

Dependency changes

• Updated@ossmo/my-multi-miner@^1.0.8