avo 2.0.0 → 3.0.0-beta.0

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 (3) hide show
  1. package/README.md +7 -7
  2. package/cli.js +1648 -2085
  3. package/package.json +40 -27
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  ## Install
4
4
 
5
- To install the latest version of Avo CLI, run this command:
5
+ Avo runs on Node `>=14.16`. To install the latest version of Avo CLI, run this command:
6
6
 
7
7
  ```
8
8
  npm install -g avo
@@ -40,16 +40,16 @@ For more detailed documentation, visit [https://www.avo.app/docs/commands](https
40
40
 
41
41
  Thank you, you are precious to us :hug: Please send an email to friends@avo.app or file an issue here on GitHub.
42
42
 
43
- ## How to Commit
43
+ ## How to contribute
44
44
 
45
- ```
46
- yarn commit
47
- ```
45
+ Make your changes and add them to the _Unreleased_ section in CHANGELOG.md
48
46
 
49
47
  ## How to Create a Release
50
48
 
51
- 1. Update the semantic version in `package.json`
52
- 2. Publish the package to npm
49
+ 1. Verify that the changes in the _Unrelased_ section in CHANGELOG.md are accurate, create a new heading with the correct semantic version then move the content from the _Unreleased_ section there
50
+ 2. Update the semantic version in `package.json` to match the one you just created in the changelog
51
+ 3. Commit with the message "Release <version>" and push the changes
52
+ 4. Publish the package to npm (you'll need to be a maintainer of the avo project in npm)
53
53
 
54
54
  ```
55
55
  npm publish