Updated README with changes.

This commit is contained in:
deepjyoti30
2020-05-16 12:21:05 +05:30
parent e24a6638cc
commit 5cf7318c5c
2 changed files with 25 additions and 2 deletions

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) [2020] [Deepjyoti Barman]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -28,13 +28,15 @@ Just another minimal startpage for browsers.
## Upcoming ## Upcoming
~~I'm thinking of pushing the add on to their respective add on stores, I'll add that ASAP.~~ Will be availabe on Firefox and Chrome add on stores in a while.
I thought I would work on adding a settings page that would handle the updating the settings but I'm just way to bored and honestly I've come to realize I hate GUI's (I mean I've always loved CLI based apps). Anyway, the extension can still be used and I'm sure the crowd I aimed this extension at knows how to edit a ```json``` file, for the time being I'll just let you guys install it and use it and edit the settings from the ```config```. I thought I would work on adding a settings page that would handle the updating the settings but I'm just way to bored and honestly I've come to realize I hate GUI's (I mean I've always loved CLI based apps). Anyway, the extension can still be used and I'm sure the crowd I aimed this extension at knows how to edit a ```json``` file, for the time being I'll just let you guys install it and use it and edit the settings from the ```config```.
## Settings ## Settings
For the time being you need to edit the ```config.json``` file present in the root directory of the repo and then install the extension by following the above steps. You can edit the settings by writing ```--setting``` in the search bar and clicking enter.
A JSON editor will open up where you can make the changes.
| Name | Supported Values | Default | Description | | Name | Supported Values | Default | Description |
| ---- | ----- | ------- | ------ | | ---- | ----- | ------- | ------ |