prepare-package 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +12 -1
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -42,7 +42,8 @@ After installing via npm, simply put this in your `package.json`
42
42
  ...
43
43
  "main": "dist/index.js",
44
44
  "scripts": {
45
- "prepare": "node -e 'require(`prepare-package`)()'"
45
+ "prepare": "node -e 'require(`prepare-package`)()'",
46
+ "prepare:watch": "nodemon -w src -e '*' --exec 'npm run prepare'"
46
47
  },
47
48
  "preparePackage": {
48
49
  "input": "src",
@@ -56,5 +57,15 @@ After installing via npm, simply put this in your `package.json`
56
57
  * `preparePackage.out`: The dir to copy **to**.
57
58
  * `main`: The file to copy and use as your main file. Tags like `{version}` are replaced in this file.
58
59
 
60
+ ## Usage
61
+ ### Run Prepare Package
62
+ ```shell
63
+ # Run once
64
+ npm run prepare
65
+
66
+ # Run and watch for changes
67
+ npm run prepare:watch
68
+ ```
69
+
59
70
  ## Final Words
60
71
  If you are still having difficulty, we would love for you to post a question to [the Prepare Package issues page](https://github.com/itw-creative-works/prepare-package/issues). It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)
package/package.json CHANGED
@@ -1,12 +1,13 @@
1
1
  {
2
2
  "name": "prepare-package",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Prepare a Node.js package before being published",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {
7
7
  "test": "./node_modules/mocha/bin/mocha test/ --recursive --timeout=10000",
8
8
  "start": "node -e 'require(`./src/index.js`)()'",
9
- "prepare": "node -e 'require(`./src/index.js`)()'"
9
+ "prepare": "node -e 'require(`./src/index.js`)()'",
10
+ "prepare:watch": "nodemon -w src -e '*' --exec 'npm run prepare'"
10
11
  },
11
12
  "preparePackage": {
12
13
  "input": "src",