docs: add Readme
This commit is contained in:
parent
327e33a7e3
commit
ff4ad7ca60
1 changed files with 57 additions and 0 deletions
57
README.md
Normal file
57
README.md
Normal file
|
@ -0,0 +1,57 @@
|
|||
# Trello to Deck
|
||||
|
||||
Migrate your Trello Board to Nextcloud Deck.
|
||||
|
||||
## Getting Started
|
||||
|
||||
- Install `trello-to-deck`:
|
||||
|
||||
e.g.
|
||||
|
||||
```bash
|
||||
cargo install trello-to-deck
|
||||
```
|
||||
|
||||
- Create a starter configuration file
|
||||
|
||||
```bash
|
||||
trello-to-deck init
|
||||
```
|
||||
|
||||
This will create a `trello-to-deck.toml` file in the current directory.
|
||||
|
||||
Edit this file to add your Trello and Nextcloud credentials.
|
||||
|
||||
### Trello Credentials
|
||||
|
||||
To autheniticate to Trello and be able to download the attachements for each card, you need to register a Power Up as a Developer.
|
||||
This is free and easy, following these instructions;
|
||||
|
||||
- Login to <https://trello.com/>
|
||||
- Visit: <https://trello.com/power-ups/admin>
|
||||
- Click *New* to create a new Power-Up/Integration
|
||||
- Complete the *New Power-Up or Integration* form:
|
||||
- Power-Up or Integrtation Name: *Trello to Deck*
|
||||
- Workspace: select the workspace you went to export your boards from
|
||||
- IFrame: (ignore)
|
||||
- Email: your email
|
||||
- Support: your email
|
||||
- Author: your name
|
||||
- Click *Create*
|
||||
- API Key: click *Generate a new API key* (twice)
|
||||
- Copy your *API key* into your `trello-to-deck.toml` file
|
||||
- To the right of the API Key, click on the *Token* link at the end of the paragraph.
|
||||
- On the 'Would you like to give the following application access to your account?' page, scroll down and click *Allow*
|
||||
- Copy the token into you `trello-to-deck.toml` file
|
||||
|
||||
### Nextcloud Credentials
|
||||
|
||||
TODO
|
||||
|
||||
### Verify configuration
|
||||
|
||||
Run the `check` command to validate your configuration:
|
||||
|
||||
```bash
|
||||
trello-to-deck check
|
||||
```
|
Loading…
Reference in a new issue