diff --git a/README.md b/README.md index cc7200b..9ba74d2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Mastodon_Tools +# Mastodon Tools -Various little tools for interacting with Mastodon. You will need to register for a access token on your Mastodon instance. Ask your admin if you're unsure. +Various little tools Python for interacting with Mastodon. You will need to register for a access token on your Mastodon instance. Ask your admin if you're unsure. ## On This Day @@ -10,4 +10,10 @@ This service shows all the posts you made on this day in previous years. ## Threads -This lets you visualise a conversation tree. Give it the ID of any post on your instance and it will get all the replies to it. \ No newline at end of file +This lets you visualise a conversation tree. Give it the URL of any post on your instance and it will get all the replies to it. + +Usage: + +`python3 threads.py https://your_mastodon.instance/@username@their.instance/1234` + +⚠ Note! Large conversations may take a long time to retrieve from the API. \ No newline at end of file