usrspace-browser-addon/README.md
Thomas Rupprecht 9740fc47a7 improve README
2023-01-05 17:14:32 +01:00

47 lines
875 B
Markdown

# /usr/space Web-Ext (Firefox Add-on)
## Features
- Show if someone is in the Space
- Looks for connected dynamic IPs (DHCP)
- Refreshes every 5min
- Show the next event
- Quick-Links (Homepage, Wiki, Gitea, Nextcloud)
## Install
```ssh
$ git clone https://gitea.usrspace.at/XimeX/usrspace-browser-addon.git
$ npm i -g web-ext
$ npm i
```
## Run / Develop / Debug
```ssh
$ npm run watch:{firefox|firefox-android|chromium}
```
If more options are needed add them after a `--`.
Some useful options:
- `--devtools`
- `--firefox-apk=...`
- `--android-device=...`
Example: `npm run watch:firefox-android -- --firefox-apk=org.mozilla.fenix --firefox-device=XXXXXXXX`.
## Build
```ssh
$ npm run build
```
## Release
```ssh
$ npm version {major|minor|patch|...}
```
## Credits
Used icons from Bootstrap
https://github.com/twbs/icons/blob/main/LICENSE.md
## License
MIT