diff --git a/README.md b/README.md index 164d25d..ee8dc74 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,35 @@ -# Sloth +# Sloth -`Sloth` - an extension to make you suffer, browsing the web. +An extension that slowing down network and CPU and makes you experience web page performance as your real users. -Do you think that users have fast device/connection as you as developer has? +
+ +
-No they are not. Their devices/connections are slow! Very slooow! +Do you think that users have fast device/connection as you as developer has? -![](https://user-images.githubusercontent.com/6231516/36938869-cb6b0c92-1f30-11e8-9085-26b386b7a39a.gif) +No they are not. Their devices/connections are slow! Very slooow! `Sloth` makes you suffer browsing the web like your real users. --- -So enabling network and cpu throttling to have the same user experience. +## Recently asked questions + +### How it works? ---- +`Sloth` uses [Chrome Devtools Protocol](https://chromedevtools.github.io/devtools-protocol/) to slow down connection and throttle CPU. -## Conditions: +### What are the conditions? -- CPU: `2x` throttling +`Sloth` applies `4x` CPU throttling and slowind down network to `1.6Mbps` - for download, `750Kbps` - for upload. +Interested in optional configurations - take a part in [issue](https://github.com/denar90/sloth/issues/1) discussion -- Network connection: `1.6Mbps` - download, `750Kbps` - upload -## Recently asked questions +### Why do I need it while @chrome-devtools can do the same? - - Question: Why do I need it while @chrome-devtools can do the same? - - Answer: Yes and no. DevTools can do it for opened tab, but you have to do a lot of manipulations to apply throttling (open dev tools, open proper tab, apply throttling etc). This extension is for lazy people, you just press one button and all URLs with same origin will have throttling. Handy isn't it? +Yes and no. DevTools can do it for opened tab, but you have to do a lot of manipulations to apply throttling (open dev tools, open proper tab, apply throttling etc). This extension is for lazy people, you just press one button and all URLs with same origin will have throttling. Handy isn't it? ---- -## Testing - -Extension is tested using [puppeteer](https://github.com/GoogleChrome/puppeteer). -Token was generated to rich tested extension page. It's value stored in fixtures the same as fixture for manifest.json. -All other files (background.js, popup.html, popup.js) are symlinks (./extension -> ./test/fixtures) - -> Note: to update symlink files run: ln -s "$(pwd)"/extension/* test/fixtures/ - ## Development After adding new permissions commands below has to be run. @@ -51,6 +46,14 @@ After adding new permissions commands below has to be run. ``` +## Testing + +Extension is tested using [puppeteer](https://github.com/GoogleChrome/puppeteer). +Token was generated to rich tested extension page. It's value stored in fixtures the same as fixture for manifest.json. +All other files (background.js, popup.html, popup.js) are symlinks (./extension -> ./test/fixtures) + +> Note: to update symlink files run: ln -s "$(pwd)"/extension/* test/fixtures/ + ## Demo