README.md in tapioca-0.2.0 vs README.md in tapioca-0.2.1
- old
+ new
@@ -19,10 +19,11 @@
```shell
$ bundle exec tapioca
Commands:
tapioca generate [gem...] # generate RBIs from gems
tapioca help [COMMAND] # Describe available commands or one specific command
+ tapioca init # initializes folder structure
tapioca sync # sync RBIs to Gemfile
Options:
--pre, -b, [--prerequire=file] # A file to be required before Bundler.require is called
--post, -a, [--postrequire=file] # A file to be required after Bundler.require is called
@@ -32,10 +33,16 @@
--typed, -t, [--typed-overrides=gem:level] # Overrides for typed sigils for generated gem RBIs
```
## Usage
+### Initialize folder structure
+
+Command: `tapioca init`
+
+This will create the `sorbet/config` and `sorbet/tapioca/require.rb` files for you, if they don't exist. If any of the files already exist, they will not be changed.
+
### Generate for gems
Command: `tapioca generate [gems...]`
This will generate RBIs for the specified gems and place them in the RBI directory.
@@ -54,10 +61,10 @@
- `--generate_command [command]`: The command to run to regenerate RBI files (used in header comment of the RBI files), defaults to the current command.
- `--typed_overrides [gem:level]`: Overrides typed sigils for generated gem RBIs for gem `gem` to level `level` (`level` can be one of `ignore`, `false`, `true`, `strict`, or `strong`, see [the Sorbet docs](https://sorbet.org/docs/static#file-level-granularity-strictness-levels) for more details).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/tapioca. 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/Shopify/tapioca. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://github.com/Shopify/tapioca/blob/master/CODE_OF_CONDUCT.md) code of conduct.
## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://github.com/Shopify/tapioca/blob/master/LICENSE.txt).