Skip to content

Commit

Permalink
Merge pull request #8 from mark-pitblado/develop
Browse files Browse the repository at this point in the history
Add installation instructions
  • Loading branch information
mark-pitblado authored Nov 11, 2024
2 parents 89a7074 + 25feb8a commit d20b9c6
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@

This is a simple terminal user interface for [vikunja](https://vikunja.io). The purpose is to allow users to manage tasks from the terminal, using their own API key. This project is not managed or affiliated with the Vikunja team.

## Installation

```
cargo install vikunja-tui
```

## Setup

Place the following two values in a `.toml` file within your configuration files under the `vikunja-tui` directory. The instance url should not contain `api/v1`, just the base url for your instance. The api key just needs read and write access to tasks.
Expand Down

0 comments on commit d20b9c6

Please sign in to comment.