README.md in stanwood-0.2.1 vs README.md in stanwood-0.3.0
- old
+ new
@@ -1,10 +1,10 @@
# Stanwood
[![Gem Version](https://badge.fury.io/rb/stanwood.svg)](https://badge.fury.io/rb/stanwood)
-stanwood Command line tool support stanwood architecture, generates base projects with boiler plate code, and necessary templates.
+// TODO
## Installation
Add this line to your application's Gemfile:
@@ -17,48 +17,25 @@
$ bundle
```
Or install it yourself as:
```
- $ sudo gem install stanwood
+ $ gem install stanwood
```
## Usage
-```
-Usage:
+TODO: Write usage instructions here
- $ stanwood COMMAND
- Stanwood, the stanwood architecture template manager
-
-Commands:
-
- + create Create a new project template
- + install Installs project templates
-
-
-Options
-
- --ios Sets iOS platform attribue
- --backend Sets Android platform attribue
- --android Sets API platform attribue
- -v, --version Print version number
- -h, --help Show help banner of specified command
-```
-
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/stanwood/stanwood. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/stanwood. 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.
## Code of Conduct
Everyone interacting in the Stanwood project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/stanwood/blob/master/CODE_OF_CONDUCT.md).
-
-## Licence
-
-stanwood is under MIT licence. See the [LICENSE](https://github.com/stanwood/stanwood-xctemplate/blob/master/LICENSE.md) file for more info.