Add TODOs and clarify somethings in README

This commit is contained in:
Intercal
2025-08-13 16:09:04 -07:00
parent 4d12d2a643
commit 768097a3a7

View File

@@ -3,6 +3,8 @@
This is a simple Tumblr CLI for making posts. Use this to automate your posting workflow as a bot, This is a simple Tumblr CLI for making posts. Use this to automate your posting workflow as a bot,
or outsource your posts to your favorite editor and post them that way. or outsource your posts to your favorite editor and post them that way.
**NOTE**: This is for making posts only. It's not used to read Tumblr posts in the CLI.
## Configuring ## Configuring
Before running, you need to get your oauth key/secret and client key/secret from the Tumblr API. Before running, you need to get your oauth key/secret and client key/secret from the Tumblr API.
@@ -63,8 +65,8 @@ It will read the contents of `post.txt` and post that instead.
### Autoformatting caveats ### Autoformatting caveats
Tumblr, by default, does not automatically split up text into paragraphs. If your text chunk has two Tumblr, by default, does not automatically split up text into paragraphs. However, the CLI will do
newlines in a row, e.g.: this for you. If your text chunk has two newlines in a row, e.g.:
``` ```
This is the first paragraph This is the first paragraph
@@ -94,3 +96,10 @@ python3 -m tcli --help
# Options for posting # Options for posting
python3 -m tcli post --help python3 -m tcli post --help
``` ```
# TODO
* [ ] Video uploads
* [ ] Preserving whitespace flag
* [ ] Raw JSON mode
* [ ] Proper logging