Cleanup documentation
This commit is contained in:
34
README.md
34
README.md
@@ -1,16 +1,38 @@
|
||||
# cmdasana
|
||||
A curses CLI for Asana, using the Asana API.
|
||||
|
||||
Requirments:
|
||||
## Requirments
|
||||
* python 3
|
||||
* [python-asana](https://github.com/Asana/python-asana)
|
||||
* [urwid (included)](http://urwid.org)
|
||||
* python 2
|
||||
* [urwid](http://urwid.org)
|
||||
* [pyhon-dateutil](https://github.com/dateutil/dateutil/)
|
||||
|
||||
Usage:
|
||||
## Setup
|
||||
### Create an Asana OAuth app
|
||||
See [instructions from Asana](https://asana.com/developers/documentation/getting-started/auth#register-an-app)
|
||||
on how to create a new app. Use `urn:ietf:wg:oauth:2.0:oob` as the redirect
|
||||
URL.
|
||||
|
||||
Once you create your app, save your client ID and secret in a file `secrets.py`:
|
||||
```python
|
||||
CLIENT_ID='...'
|
||||
CLIENT_SECRET='...'
|
||||
```
|
||||
make
|
||||
./cmdasana.py
|
||||
|
||||
### Install dependencies
|
||||
Using `pip`:
|
||||
```
|
||||
pip3 install asana urwid python-dateutil
|
||||
```
|
||||
|
||||
## Usage
|
||||
```
|
||||
./main.py
|
||||
```
|
||||
|
||||
When you first cmdasana, you will need to authorize the app in your browser.
|
||||
Copy and paste your OAuth key into the terminal to get started.
|
||||
|
||||
## Navigation
|
||||
Use arrow keys to navigate, `<enter>` to "click", and `<backspace>` to return to
|
||||
the previous page.
|
||||
|
||||
Reference in New Issue
Block a user