diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29..a575dd3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +## Version 2.0.0 + +##### Improvements + +- frontend done in Vue +- backend using customized Vue CLI scaffolding +- UI styling done in Vuetify +- uses localstorage vs sync storage via Vuex +- switched to `webextension-polyfill` for cross-browser capability. + - still need to implement the automation. +- made use of the native `browser.tabs` api over using content-scipts and a confusing messaging system. + +## Version 1.0.0 + +##### Initial Release + +- pure js implementation +- basically no styling +- basic functionally diff --git a/README.md b/README.md index 00e52d8..c03d2dc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Titlest -a simple extension to replace or append a websites title with whatever you want. the extension name is a play on the golf brand. no, i dont like golf. +a simple extension to replace or append a websites title with whatever you want. the extension name is a play on the golf brand. no, im not a golfer. + +![alt text](res/popup.png "Popup Menu") ## Overview @@ -10,44 +12,30 @@ the code is sloppy and probably redundant but its part of the learning process. ## Installation -_before i push the extension to the respective browser stores i need to convert from sync storage to local storage. so be warned that your data could could be lost in an update. i also need to make it cross browser compatible with firefox._ +> ~~before i push the extension to the respective browser stores i need to convert from sync storage to local storage. so be warned that your data could could be lost in an update.~~ i also need to make it cross browser compatible with firefox.\_ -- first you need to put the files on your local system by cloning or downloading the repository and extracting it. +- first you need to download the zip containing the compiled code for the [latest release](https://github.com/kinghat/Titlest/releases) and extract it to a directory of your choosing. -- to install in chrome go to `chrome://extensions/` in your navigation bar. turn on "Developer Mode" in the top right and the click on the "Load unpacked" in the top left. select the `src/` directory. it should now be loaded as an "unpacked extension." +- to install in chrome go to `chrome://extensions/` in your navigation bar. turn on "Developer Mode" in the top right and the click on the "Load unpacked" in the top left. select the directory you extracted the zip to. it should now be loaded as an "unpacked extension." ## Development ### Project setup -``` -yarn install -``` - -#### Compiles and hot-reloads for development - -``` -yarn run serve -``` - -#### Compiles and minifies for production +#### Clone or download the repository -``` -yarn run build -``` +use whichever method you want to obtain the code from the repo -#### Run your tests +#### Compile and hot-reload for development ``` -yarn run test +yarn serve +npm run serve ``` -#### Lints and fixes files +#### Compile and minify for production ``` -yarn run lint +yarn build +npm run build ``` - -#### Customize configuration - -See [Configuration Reference](https://cli.vuejs.org/config/). diff --git a/res/popup.png b/res/popup.png new file mode 100644 index 0000000..54ec376 Binary files /dev/null and b/res/popup.png differ