README.md in tay-0.0.3 vs README.md in tay-0.0.4
- old
+ new
@@ -1,13 +1,25 @@
# Tay
Tay is designed to help you swiftly write Google Chrome extensions using your favourite languages and tools.
+## Quickstart
+
+ $ gem install tay
+ $ tay new my_extension
+ $ cd my_extension
+ $ tay generate browser_action
+ $ tay build
+
+Now go and load your extension in Chrome and look in the top right for the puzzle piece!
+
## Installation
$ gem install tay
+If installing the gem from source, be sure to run `rake build_generators` first!
+
## Usage
Tay helps create, bootstrap, develop and publish Chrome extentions. It all works through the `tay` command. Running `tay` alone will show you a list of commands.
### Creating
@@ -69,11 +81,11 @@
Build the current extension
If you run `tay watch` in the top level directory, tay will automatically build whenever a change is detected in the `src` directory *(you still need to go and reload the unpacked extension in Chrome)*.
-To use `tay watch` you'll need to add the `[guard-tay](http://github.com/rixth/guard-tay` gem to your Gemfile and run `bundle install`. If you want to customize the directories that are watched for changes, you can generate a [Guardfile](http://github.com/guard/guard) by running `guard init tay`.
+To use `tay watch` you'll need to add the [guard-tay](http://github.com/rixth/guard-tay) gem to your Gemfile and run `bundle install`. If you want to customize the directories that are watched for changes, you can generate a [Guardfile](http://github.com/guard/guard) by running `guard init tay`.
Usage:
tay watch
Options:
@@ -83,11 +95,11 @@
Watch the current extension and recompile on file change
### Minifying
-If you have the `[uglifier](https://github.com/lautis/uglifier)` and/or `[yui-compressor](https://github.com/sstephenson/ruby-yui-compressor)` gems in your Gemfile, you will be able to minify the JS and CSS in a built extension.
+If you have the [uglifier](https://github.com/lautis/uglifier) and/or [yui-compressor](https://github.com/sstephenson/ruby-yui-compressor) gems in your Gemfile, you will be able to minify the JS and CSS in a built extension.
Usage:
tay minify
Options:
@@ -128,8 +140,7 @@
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## TODO
-* Generators that can also make haml/coffeescript
* Localization of extensions
* Generator for extension option pages
\ No newline at end of file