README.md 1.35 KB
Newer Older
1
# Mark
Mauricio Giacomini Girardello's avatar
Mauricio Giacomini Girardello committed
2

3
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/mark`. To experiment with that code, run `bin/console` for an interactive prompt.
Mauricio Giacomini Girardello's avatar
Mauricio Giacomini Girardello committed
4

5
TODO: Delete this and the text above, and describe your gem
Mauricio Giacomini Girardello's avatar
Mauricio Giacomini Girardello committed
6

7
8
9
## Installation

Add this line to your application's Gemfile:
Mauricio Giacomini Girardello's avatar
Mauricio Giacomini Girardello committed
10
11

```ruby
12
13
gem 'mark'
```
14

15
And then execute:
Bruno Nocera Zanette's avatar
Bruno Nocera Zanette committed
16

17
    $ bundle
Bruno Nocera Zanette's avatar
Bruno Nocera Zanette committed
18

19
Or install it yourself as:
Bruno Nocera Zanette's avatar
Bruno Nocera Zanette committed
20

21
    $ gem install mark
Bruno Nocera Zanette's avatar
Bruno Nocera Zanette committed
22

23
## Usage
Bruno Nocera Zanette's avatar
Bruno Nocera Zanette committed
24

25
TODO: Write usage instructions here
Bruno Nocera Zanette's avatar
Bruno Nocera Zanette committed
26

27
## Development
Bruno Nocera Zanette's avatar
Bruno Nocera Zanette committed
28

29
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Bruno Nocera Zanette's avatar
Bruno Nocera Zanette committed
30

31
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).
Bruno Nocera Zanette's avatar
Bruno Nocera Zanette committed
32

33
## Contributing
Bruno Nocera Zanette's avatar
Bruno Nocera Zanette committed
34

35
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mark. 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.
Bruno Nocera Zanette's avatar
Bruno Nocera Zanette committed
36