Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 822 Bytes

README.md

File metadata and controls

32 lines (20 loc) · 822 Bytes
Raw

Overlord

Overlord is a command-line based personal assistant. It can take notes, maintain a journal, set reminders and more.

Requirements

Overlord requires Go 1.13 or later.

Usage

Overlord is used from the command line. It creates a folder in your $HOME called ~/.overlord/ and saves all application data there.

Overlord expects a command to execute.

Commands

TODO: List all commands

Installation

  1. Run go get nirenjan.org/overlord
  2. Run overlord init and it will automatically take care of the rest.

Contributing

  1. Fork it ( https://github.com/nirenjan/go-overlord/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