From 9b931e315f965689f7b12690779a46744195fe04 Mon Sep 17 00:00:00 2001
From: Paul Campbell <pcampbell@kemitix.net>
Date: Tue, 31 Dec 2024 19:19:33 +0000
Subject: [PATCH] docs: add Import section to readme

Remove development notes
---
 README.md | 57 +++++++++++++++++++++++++++----------------------------
 1 file changed, 28 insertions(+), 29 deletions(-)

diff --git a/README.md b/README.md
index d9ee9d2..60f183b 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,22 @@ This will create a `trello-to-deck.toml` file in the current directory.
 
 Edit this file to add your Trello and Nextcloud credentials.
 
+### Import
+
+To import your Trello Board into Nextcloud Deck, use the command:
+
+```bash
+trello-2-deck import
+```
+
+This will read the credentials from the `trello-2-deck.toml` file in the current
+directory. You will prompted to select a Trello Board, then some or all of the
+Lists from that Board. To begin your import, select the Nextcloud Deck Board
+to add the lists and cards to.
+
+It is recommended to create a test board to confirm importing is working as you
+expect.
+
 ### 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.
@@ -64,33 +80,16 @@ Run the `check` command to validate your configuration:
 trello-to-deck check
 ```
 
-## Support
+## Support Features
 
-| Feature                  | Supported   |
-|--------------------------|-------------|
-| Stacks/Lists             | y           |
-| Cards                    | y           |
-| Card Title               | y           |
-| Card Description         | y           |
-| Card Labels              | y           |
-| Card Attachments (files) | y           |
-| Card Attachments (links) | n           |
-| Card Due Date            | n (planned) |
-
-## Development
-
-As part of building the import server, the following commands exercise each operation involved:
-
-- [x] trello member get - includes list of boards
-- [x] trello board get - includes list of stacks
-- [x] trello stack get - includes list of cards
-- [x] trello card get - includes list of attachments
-- [x] trello attachment get - includes download url
-- [x] trello attachment save - saves to disk
-- [x] nextcloud deck get - includes list of boards
-- [x] nextcloud board get - includes list of stacks
-- [x] nextcloud stack get - includes list of cards
-- [x] nextcloud card get - shows card title
-- [x] nextcloud card create
-- [x] nextcloud card add-label
-- [x] nextcloud card add-attachment
\ No newline at end of file
+| Feature                  | Supported |
+|--------------------------|-----------|
+| Stacks/Lists             | y         |
+| Cards                    | y         |
+| Card Title               | y         |
+| Card Description         | y         |
+| Card Labels              | y         |
+| Card Attachments (files) | y         |
+| Card Attachments (links) | n         |
+| Card Due Date            | y         |
+| Card Assignment          | n         |
\ No newline at end of file