Sha256: 1bd3d030e275927721b8fcd05c70b811bade0901df8cf7588148f25a2798339f

Contents?: true

Size: 1.8 KB

Versions: 2

Compression:

Stored size: 1.8 KB

Contents

# Citation

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/citation`. To experiment with that code, run `bin/console` for an interactive prompt.

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

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'citation'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install citation

## Usage

### Command line
`cite instr \<citation string\> `

### in Ruby code

```
require 'citation/citation'
citation = Citation.parse(citation string in paper)

citation.out('bibtex') #=> Convert bibtex format
citation.out('MLA')    #=> Convert MLA format
citation.out('APA')    #=> Convert APA format
citation.out('ISO')    #=> Convert ISO 690 format

```

## 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/[USERNAME]/citation. 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.


## License

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

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
citation-0.1.1 README.md
citation-0.1.0 README.md