0ct0pu5/magma
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Help-14 2022-04-15 09:49:13 +07:00 • committed by GitHub
parent ec7d919f46
commit b68d50ceea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -13,14 +13,12 @@ Personal dashboard inspired by flame, highly customizable, lightweight and respo
## How to use
* Download our [docker-compose.yml](./docker-compose.yml) file
* Start with `docker-compose up -d`
* Go to `public/config.json` to config your dashboard
* Go to `public/data.json` to edit your bookmarks
* Go to `common/config.yaml` to config your dashboard
* Go to `common/data.yaml` to edit your bookmarks
* See your dashboard at [localhost:7001](http://localhost:7001)
## Customization
Go to our [website](https://magma.help14.com) and read the document to learn more.
Long story short: [private folder](./src/private) is the original source code of the dashboard, anything in [public folder](./src/public) will replace the file with the same path in [private/themes/{selected theme}](./src/private/themes).
## Contribution
Contributions welcome and needed!