Updated README.md with new screenshots, new installation guide and weather module instructions
21
README.md
|
@ -34,7 +34,10 @@ npm run dev-init
|
||||||
npm run dev
|
npm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building Docker images
|
## Installation
|
||||||
|
|
||||||
|
### With Docker (recommended)
|
||||||
|
#### Building images
|
||||||
```sh
|
```sh
|
||||||
# build image for amd64 only
|
# build image for amd64 only
|
||||||
docker build -t flame .
|
docker build -t flame .
|
||||||
|
@ -47,33 +50,43 @@ docker buildx build \
|
||||||
-t flame:multiarch .
|
-t flame:multiarch .
|
||||||
```
|
```
|
||||||
|
|
||||||
## Deployment with Docker
|
#### Deployment
|
||||||
```sh
|
```sh
|
||||||
# run container
|
# run container
|
||||||
docker run -p 5005:5005 -v /path/to/data:/app/data flame
|
docker run -p 5005:5005 -v /path/to/data:/app/data flame
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Without Docker
|
||||||
|
Follow instructions from wiki: [Installation without Docker](https://github.com/pawelmalak/flame/wiki/Installation-without-docker)
|
||||||
|
|
||||||
## Functionality
|
## Functionality
|
||||||
- Applications
|
- Applications
|
||||||
- Create, update and delete applications using GUI
|
- Create, update, delete and organize applications using GUI
|
||||||
- Pin your favourite apps to homescreen
|
- Pin your favourite apps to homescreen
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
- Bookmarks
|
- Bookmarks
|
||||||
- Create, update and delete bookmarks and categories using GUI
|
- Create, update, delete and organize bookmarks and categories using GUI
|
||||||
- Pin your favourite categories to homescreen
|
- Pin your favourite categories to homescreen
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
- Weather
|
- Weather
|
||||||
- Get current temperature, cloud coverage and weather status with animated icons
|
- Get current temperature, cloud coverage and weather status with animated icons
|
||||||
|
|
||||||
- Themes
|
- Themes
|
||||||
- Customize your page by choosing from 12 color themes
|
- Customize your page by choosing from 12 color themes
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
### Setting up weather module
|
||||||
|
1. Obtain API Key from [Weather API](https://www.weatherapi.com/pricing.aspx).
|
||||||
|
> Free plan allows for 1M calls per month. Flame is making less then 3K API calls per month.
|
||||||
|
2. Get lat/long for your location. You can get them from [latlong.net](https://www.latlong.net/convert-address-to-lat-long.html).
|
||||||
|
3. Enter and save data. Weather widget will now update and should be visible on Home page.
|
||||||
|
|
||||||
### Supported URL formats for applications and bookmarks
|
### Supported URL formats for applications and bookmarks
|
||||||
#### Rules
|
#### Rules
|
||||||
- URL starts with `http://`
|
- URL starts with `http://`
|
||||||
|
|
BIN
github/_apps.png
Before Width: | Height: | Size: 125 KiB After Width: | Height: | Size: 90 KiB |
Before Width: | Height: | Size: 179 KiB After Width: | Height: | Size: 93 KiB |
BIN
github/_home.png
Before Width: | Height: | Size: 134 KiB After Width: | Height: | Size: 75 KiB |
Before Width: | Height: | Size: 187 KiB After Width: | Height: | Size: 226 KiB |