Create README.md

This commit is contained in:
abhijithvijayan
2019-01-04 22:16:25 +05:30
parent ac44d14060
commit 8b8547e05b

15
README.md Normal file
View File

@@ -0,0 +1,15 @@
<div align="center"><img width="100" src="src/assets/logo.svg" /></div>
<h1 align="center">kuttURL-Chrome</h1>
<p align="center">Chrome extension to to shorten URLs</p>
In the beta stage :)
## How to use
- You need an API Key from `https://kutt.it/`
- Replace the value of `API_key` in `src/scripts/background.js` with the generated key.
- `npm run dev` to to watch file changes in developement.
- `npm run build` to build the extension.
- Load extension via `chrome://extensions` as unpacked from `extension/` directory.
## Licence
Code released under the [MIT License](LICENSE).