Update README.md
This commit is contained in:
parent
3aa7ba9d96
commit
7423ae6ace
34
README.md
34
README.md
@ -30,6 +30,9 @@
|
|||||||
<li><a href="#built-with">Built With</a></li>
|
<li><a href="#built-with">Built With</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="#screenshots">Screenshots</a>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="#getting-started">Getting Started</a>
|
<a href="#getting-started">Getting Started</a>
|
||||||
<ul>
|
<ul>
|
||||||
@ -64,24 +67,43 @@ That is why I wanted to create my own project, in a language I understand, and t
|
|||||||
|
|
||||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Built With
|
### Built With
|
||||||
|
|
||||||
- .NET-Core
|
- .NET-Core
|
||||||
- Newtonsoft.JSON
|
- Newtonsoft.JSON
|
||||||
- Love <3
|
- Love <3 Blåhaj 🦈
|
||||||
|
|
||||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|
![image](screenshots/overview.png)
|
||||||
|
|
||||||
|
![image](screenshots/addtask.png)
|
||||||
|
|
||||||
|
| ![image](screenshots/settings.png) | ![image](screenshots/publication-description.png) |
|
||||||
|
|-----------------------------------:|:-------------------------------------------------:|
|
||||||
|
|
||||||
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
<!-- GETTING STARTED -->
|
<!-- GETTING STARTED -->
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
To use head over to [releases](https://git.bernloehr.eu/glax/Tranga/releases) and download a release.
|
There is two release types:
|
||||||
|
|
||||||
A CLI will guide you through setup.
|
- CLI
|
||||||
|
- Docker
|
||||||
|
|
||||||
|
### CLI
|
||||||
|
|
||||||
|
Head over to [releases](https://git.bernloehr.eu/glax/Tranga/releases) and download. The CLI will guide you through setup.
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
|
||||||
|
Download [docker-compose.yaml](https://git.bernloehr.eu/glax/Tranga/src/branch/master/docker-compose.yaml) and configure to your needs.
|
||||||
|
|
||||||
|
Wherever you are mounting `/usr/share/Tranga-API` you also need to mount that same path + `/imageCache` in the webserver container.
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
@ -90,7 +112,7 @@ A CLI will guide you through setup.
|
|||||||
<!-- ROADMAP -->
|
<!-- ROADMAP -->
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|
||||||
- [ ] Web-UI #1
|
- [x] Web-UI #1
|
||||||
- [ ] More Connectors
|
- [ ] More Connectors
|
||||||
- [ ] Manganato #2
|
- [ ] Manganato #2
|
||||||
- [ ] ?
|
- [ ] ?
|
||||||
|
Loading…
Reference in New Issue
Block a user