diff --git a/README.md b/README.md new file mode 100644 index 0000000..8ca5fd3 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Read Time + +This Javascript widget displays the reading time for a WriteFreely article. + +![](https://i.snap.as/6lBRSnZ5.png) + +## Requirements + +* You must be a [Write.as Pro](https://write.as/pro) user to enable Javascript widgets +* Your blog must be on \*.writeas.com or a custom domain to install this widget +* Your blog must use the **Blog** Display Format for this widget to work + +## Installation + +**Compatible with Write.as only.** + +To install this on your blog, navigate to your [Blogs](https://write.as/me/c/) page and click **Customize** under the blog you want to install this widget on. + +In the _Custom Javascript_ section, paste all the code from the `readtime.js` file included in this project. Save your changes, and you're done! Now individual articles will show their reading time at the top of the page.