Skip to content

Commit

Permalink
modify README
Browse files Browse the repository at this point in the history
  • Loading branch information
toihrk committed Sep 18, 2015
1 parent 0e3150d commit 54af77e
Showing 1 changed file with 37 additions and 12 deletions.
49 changes: 37 additions & 12 deletions README.md
@@ -1,8 +1,6 @@
# Itamae::Plugin::Recipe::Nodebrew

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/itamae/plugin/recipe/nodebrew`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem
Installs nodebrew.

## Installation

Expand All @@ -22,20 +20,47 @@ Or install it yourself as:

## Usage

TODO: Write usage instructions here

## Development
### install for single user

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
```ruby
include_recipe 'nodebrew::user'
```

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).
### install for system

## Contributing
```ruby
include_recipe 'nodebrew::system'
```

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/itamae-plugin-recipe-nodebrew. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
### node.json

```json
{
"nodebrew": {
"versions": {
"io@v3.3.0": [
{
"name": "coffee-script",
"version": "1.9.3"
}
],
"v4.0.0": [
"gulp"
]
},
"use": "v4.0.0"
}
}
```

## Contributing

## License
1. Fork it ( https://github.com/toihrk/itamae-plugin-recipe-nodebrew/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
## Special Thanks

[rutan/itamae-plugin-recipe-rtn_rbenv](https://github.com/rutan/itamae-plugin-recipe-rtn_rbenv)

0 comments on commit 54af77e

Please sign in to comment.