From 9e3f2267080678d7a2a69963b9fc6d39f8cc2ce0 Mon Sep 17 00:00:00 2001 From: Pushkar Patel <42088801+thepushkarp@users.noreply.github.com> Date: Sun, 29 Jan 2023 12:28:05 +0530 Subject: [PATCH] Update README --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9feff18..f8a5e8b 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,32 @@ Say goodbye to checking the character count manually and then deleting and rewriting your tweet! This extension shows you a character counter and provides a visual indicator of how many characters you have left to write your tweet in. -### [Do THIS FIRST] Enable Craft eXtensions +## Table of Contents + +- [(DO THIS FIRST) Enable Craft eXtensions](#do-this-first-enable-craft-extensions) +- [Installation](#installation) + - [Install from release](#install-from-release) + - [Build from source and install](#build-from-source-and-install) +- [Usage](#usage) +- [Acknowledgements](#acknowledgements) +- [License](#license) + +## (DO THIS FIRST) Enable Craft eXtensions 1. Open Craft 2. Enable eXtensions in the settings + - Mac: At the top left of the app, click your avatar, select Preferences, click Advanced. Under Craft eXtensions, click the dropdown, and select Enabled. - ![Mac](https://secure-res.craft.do/v2/5DbS6ppn13eXWaikiwEbXZeoSrYsQ4i2tif9qMkWiD3eSKbGhpvknfUvMkEvzFZEDXyEwDDJeWdBBEkLQLgHRGCwtKxs2UYvkooCSBzmekXswUsoLQ1nkPtCr9GL8mNwfQ2vSaYrgqYVipymp3vnBjcQBhSBRQd8Ytn1Ye5wmJQNcQNxQHLs5ixfddLbTo2m9nDXTUMv2Af9f7RB3kdmiVrQ4o5t37u2G92a33wJcqdqLi7Xq/Image.jpg) + + ![Mac](https://secure-res.craft.do/v2/5DbS6ppn13eXWaikiwEbXZeoSrYsQ4i2tif9qMkWiD3eSKbGhpvknfUvMkEvzFZEDXyEwDDJeWdBBEkLQLgHRGCwtKxs2UYvkooCSBzmekXswUsoLQ1nkPtCr9GL8mNwfQ2vSaYrgqYVipymp3vnBjcQBhSBRQd8Ytn1Ye5wmJQNcQNxQHLs5ixfddLbTo2m9nDXTUMv2Af9f7RB3kdmiVrQ4o5t37u2G92a33wJcqdqLi7Xq/Image.jpg) + - Web: At the top left of the web app, click your avatar, select Craft eXtensions, toggle Craft eXtensions on. - ![Web](https://secure-res.craft.do/v2/T3gqayd2mhRAhW8PpG7Nnc4Gq8xrWHFjCTvYPogTEoy87dVLP1vhGSzyz9Rkgd1yZwPyv5esAS6AyhFmziQKNF6RwAKNNrTNmqwFTLe3Sq9L2yAhJXKkJEYkLUVwgGEAi7ykNyhVNWGCqWGJv9C6LCJTHYR8ytEjwckfxU75WwKMWsp/image.jpg) + + ![Web](https://secure-res.craft.do/v2/T3gqayd2mhRAhW8PpG7Nnc4Gq8xrWHFjCTvYPogTEoy87dVLP1vhGSzyz9Rkgd1yZwPyv5esAS6AyhFmziQKNF6RwAKNNrTNmqwFTLe3Sq9L2yAhJXKkJEYkLUVwgGEAi7ykNyhVNWGCqWGJv9C6LCJTHYR8ytEjwckfxU75WwKMWsp/image.jpg) + 3. At the bottom of the right side bar, the eXtensions logo is now visible. Click it to open the eXtensions panel. - ![Extension](https://secure-res.craft.do/v2/5DbS6ppn13eXWaikiwEbXZeoSrYsQ4i2tif9qMkWiD3eSKbGhpvknfUvMkEvzFZEDXyEwDDJeWdBBEkLQLgHRGCwtKxs2UYvkooCSBzmekXswUsoLQ1nkPtCr9GL8mNwfQ2vSaYrgqYVipymp3vnBjcQBhfm4qVh9eWQwMc6UA1d2v8Eh2rqDSvVQA9sm6vjxLHC2N4UdCvEzqXuFzjQgsnBeQBaotrs4W9eNGsJujua3owEH/Image.jpg) + + ![Extension](https://secure-res.craft.do/v2/5DbS6ppn13eXWaikiwEbXZeoSrYsQ4i2tif9qMkWiD3eSKbGhpvknfUvMkEvzFZEDXyEwDDJeWdBBEkLQLgHRGCwtKxs2UYvkooCSBzmekXswUsoLQ1nkPtCr9GL8mNwfQ2vSaYrgqYVipymp3vnBjcQBhfm4qVh9eWQwMc6UA1d2v8Eh2rqDSvVQA9sm6vjxLHC2N4UdCvEzqXuFzjQgsnBeQBaotrs4W9eNGsJujua3owEH/Image.jpg) ## Installation @@ -26,7 +42,7 @@ Say goodbye to checking the character count manually and then deleting and rewri 3. Click the **+** sign, select the `tweet-helper.craftx` file you just downloaded and click **Open**. 4. Click **Install**. -### Build from source +### Build from source and install 1. Clone the repository @@ -52,10 +68,13 @@ A file named `tweet-helper.craftx` will be created. 1. Open a new Craft document or open an existing document. 2. Select the text you want to tweet. **Please note that the text should be in a single block to be identified correctly.** - ![Selected Text](https://user-images.githubusercontent.com/42088801/215260530-5d777c77-15ad-45b8-88bf-c2c2b5c2cb74.png) + + ![Selected Text](https://user-images.githubusercontent.com/42088801/215260530-5d777c77-15ad-45b8-88bf-c2c2b5c2cb74.png) + 3. Click the eXtensions logo at the bottom of the right side bar of Craft page to open the eXtensions panel and click the **Tweet Helper** extension. 4. The extension will show you a visual indicator of how many characters you have left to write your tweet in. - ![Extension](https://user-images.githubusercontent.com/42088801/215260594-5d6c7ce1-5cbe-45e3-8886-8d9b01b19344.png) + + ![Extension](https://user-images.githubusercontent.com/42088801/215260594-5d6c7ce1-5cbe-45e3-8886-8d9b01b19344.png) ## Acknowledgements