README.md in safe_pusher-0.2.2 vs README.md in safe_pusher-0.3.0
- old
+ new
@@ -35,10 +35,11 @@
```yaml
files_to_skip:
- file/to/skip_1
- file/to/skip/2
+base_branch: developement
app_base_directory: app
repo_url: https://github.com/williampollet/safe_pusher
```
## Usage
@@ -47,26 +48,52 @@
$ safepush
To run pronto checks before you push to GitHub run:
- $ safepush lint_push_and_open
+ $ safepush lint push open
or
- $ safepush lpo
+ $ safepush l p o
To run specs and pronto before you push to GitHub run:
- $ safepush test_lint_push_and_open
+ $ safepush test lint push open
or
- $ safepush tlpo
+ $ safepush t l p o
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/williampollet/safe_pusher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Development
+
+Setup development:
+
+```sh
+$ bin/setup
+```
+
+Open a console:
+
+```sh
+$ bin/console
+```
+
+Test the CLI:
+
+```sh
+$ ruby -Ilib exe/safepush
+```
+
+Launch specs and lint:
+
+```sh
+$ rake
+```
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).