From b98f26f202f60e45c17bafdf57f9cc712736bd6e Mon Sep 17 00:00:00 2001 From: Shivashis Padhi Date: Sat, 7 Nov 2020 21:44:22 +0530 Subject: [PATCH] Update README with asciinema rec, what telegra.ph doesn't support, docker image name fix --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c4ea51b..74f2e18 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,9 @@ telegra.ph from your friendly terminal. [telegra.ph](https://telegra.ph) is a minimalist content publishing platform for users to quickly share richly formatted post. `telegraphcl` lets you use telegra.ph from command-line, using Markdown file to draft your posts. +Here's what you can do with `telegraphcl` +[![asciicast](https://asciinema.org/a/371198.png)](https://asciinema.org/a/371198) + ## Installation ### Using golang installation @@ -16,12 +19,10 @@ telegra.ph from command-line, using Markdown file to draft your posts. Let's say `examples` directory has the markdown files to be used to create/edit pages. - $ docker run -v ~/.telegraphcl:/root/.telegraphcl -v "$PWD"/examples:/root/telegraph-blogs/ -it telegraphcl --help + $ docker run -v ~/.telegraphcl:/root/.telegraphcl -v "$PWD"/examples:/root/telegraph-blogs/ -it plant99/telegraphcl --help ## Usage -Note: One can run the same commands - $ telegraphcl --help ``` @@ -108,7 +109,7 @@ Create a markdown file in ``, say `first_page.md`. Then run the fo *Note for docker image users*: The `WORKDIR` is `/root/telegraph-blogs` so to reference files, you can assume you're running `telegraph` from ``. So assuming `examples` is my ``, the following would create a page. - $ docker run -v ~/.telegraphcl:/root/.telegraphcl -v "$PWD"/examples:/root/telegraph-blogs/ -it telegraphcl:latest page create tiny_blogpost.md some-title + $ docker run -v ~/.telegraphcl:/root/.telegraphcl -v "$PWD"/examples:/root/telegraph-blogs/ -it plant99/telegraphcl page create tiny_blogpost.md some-title #### list @@ -139,6 +140,17 @@ To get the count of views on a particular page, run the following command. Prints the version of `telegraphcl`. + +## Note + + +telegra.ph doesn't support all Markdown formatting + +1. h1 elements, `#` in Markdown format. +2. h2 elements, `##` in Markdown format. + +There could be others, please raise an issue in that case, the documentation would be updated. + ## Contributing Please file an issue, or make a patch via GitHub PRs if you have time.