Skip to content

seita1996/jott

Repository files navigation

E8BFE9C9-1977-478D-92AD-5509D48835EC

Test License: MIT Gem

A CLI application that allows you to create small memos. It can be installed as a Ruby Gem, and you can create, delete and display memos with the jott command.

Installation

$ gem install jott

Usage

Create a new memo

$ jott add This is first memo

or

$ jott add
-> open your editor

List memos

$ jott ls

Edit the memo

$ jott edit 1 This is updated memo

or

$ jott edit 1
-> open your editor

or

$ jott edit
-> open your editor (last memo)

Delete the memo

$ jott rm 1

Clear all memos

$ jott clear

Set the editor

$ jott set-editor vim

Check config

$ jott config

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/seita1996/jott. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Jott project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.