Skip to content

Commit

Permalink
Update readme and gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
hawkins committed Oct 27, 2018
1 parent ae0c7d8 commit 2027483
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -3,3 +3,4 @@ lard.yml
*.gem
*.gems
*.DS_Store
.idea
16 changes: 15 additions & 1 deletion README.md
Expand Up @@ -12,11 +12,26 @@ To install, simply run `gem install lard`. Then, you can run the binary by calli

You'll need to log in before you can do much, so follow instructions in `lard login` to get started.


## Contributing

I welcome contributions of all kinds! Feel free to open an issue to discuss problems, feature requests, smoothie flavors, or code changes you'd like to make. This project is meant to be useful to every Larder user, so I'd love to hear from you!

If you want to run the code locally, follow these steps:

1. Clone the repo
2. Make sure you have a supported ruby version
3. Install dependencies with `bundle install`
4. Run the local binary with `ruby bin/lard -Ilib` to reference the local `lib/lard.rb` file when `bin/lard` tries to `require 'lard'`

For brownie points you can install the `rubocop` gem and try to make sure you limit the warnings that crop up from `rubocop`, but don't sweat it since Travis CI will run this for you if you don't!

## Features

Checked boxes represent minimally viable completed features, meaning they are feature complete but may leave room for future improvement:

- [x] Log in with your application token in a config file
- [x] Log in via command line function to populate above above config file
- [x] List all of your folders
- [x] List all of the bookmarks in a folder
- [x] Search for specific bookmarks
Expand All @@ -26,4 +41,3 @@ Checked boxes represent minimally viable completed features, meaning they are fe
- [ ] Export bookmarks
- [ ] Import bookmarks
- [ ] Operate offline via cache
- [x] Login via command line to store in dotfile

0 comments on commit 2027483

Please sign in to comment.