From ac00af7bdee6d6bb806978613e6572424f72dedc Mon Sep 17 00:00:00 2001 From: Aaron Yarborough Date: Fri, 10 Apr 2020 14:11:28 +0100 Subject: [PATCH] Rename extension. Add README --- README.md | 28 ++++++++++++++++++++++++++++ src/manifest.json | 4 ++-- 2 files changed, 30 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..354597a --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Cuckoo +Cucko is a Google Chrome browser extension that lets you hide the number of likes, retweets and replies a tweet has. + +## Installation +[Download the extension](https://chrome.google.com/webstore/detail/cuckoo-for-twitter/agjappnhmfoffegbhnakelgilanmnibb) from the Chrome web store here. + +## Development +To get set up for local development, follow these steps: + + 1. Clone the repository + 2. Run `npm install` in the `src/` directory + 3. Install parceljs globally by running `npm install -g parcel-bundler` - detailed installation isntructions can be found on [the official ParcelJS documentation site](https://parceljs.org/getting_started.html). + +### Building +Run `npm run build` from `src/`. Your build will be outputted to the `build/` directory in your repository root, alongside `src/` + +## Further documentation + + - [ParcelJS documentation site](https://parceljs.org/getting_started.html) + - [Chrome extension development getting started guide](https://developer.chrome.com/extensions/getstarted) + - [TypeScript documentation](https://www.typescriptlang.org/docs/home.html) + +## Collaboration and reporting problems +If you'd like to make a change to the repository, create a fork of this repo and create a pull request for your change. + +If you'd like to report a problem, feel free to create an issue. + +Thanks! diff --git a/src/manifest.json b/src/manifest.json index 134c565..f56ed0d 100644 --- a/src/manifest.json +++ b/src/manifest.json @@ -1,6 +1,6 @@ { - "name": "Twitter Metric Hider", - "description": "Hides twitter like, reply and retweet counts.", + "name": "Cuckoo for Twitter", + "description": "Hide Twitter like, retweet and reply counts.", "version": "2.0.0", "manifest_version": 2, "content_scripts": [