README.md in myosx-0.2.1 vs README.md in myosx-0.2.2
- old
+ new
@@ -4,33 +4,32 @@
## Setup
1. Install XCode
2. [Install homebrew](http://brew.sh/)
-3. `bundle install`
+3. `gem install myosx`
+4. Create a [config file](https://github.com/surminus/myosx/blob/master/example.myosx.cnf) in `~/.myosx.cnf`
+5. `$ myosx`
-## Usage
-Notes on how to test before it's a gem. Clone repo and from inside:
-
-`RUBYLIB=$(pwd)/lib bin/myosx`
-
## Config
You can set two key configs from environment variables:
### Config file
+
`MYOSX_CONFIG`
If this isn't set then it defaults to `~/.myosx.cnf`
Use the example config file to set some things (`example.myosx.cnf`)
### Workspace directory
+
`MYOSX_WORKSPACE`
This is where everything is stored such as Brewfiles and any other repositories
-that it may pull.
+that it may pull. Default is '~/.myosx'
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/surminus/myosx. 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.