azpsen/tailfin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
April Petersen
2024-02-02 21:27:56 -06:00
committed by GitHub
parent 8f86c5ab68
commit d9203fa779
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -29,7 +29,6 @@
- [Docker](#docker) - [Docker](#docker)
- [From Source](#from_source) - [From Source](#from_source)
- [Configuration](#configuration) - [Configuration](#configuration)
- [Usage](#usage)
- [Roadmap](#roadmap) - [Roadmap](#roadmap)
## About <a name="about"></a> ## About <a name="about"></a>
@@ -40,11 +39,16 @@ I created this because I was disappointed with the options available for digital
ForeFlight is likely most commonly used, but my proclivity towards self-hosting drove me to seek out another solution. ForeFlight is likely most commonly used, but my proclivity towards self-hosting drove me to seek out another solution.
Since I could not find any ready-made self-hosted logbooks, I decided to make my own. Since I could not find any ready-made self-hosted logbooks, I decided to make my own.
#### :warning: This project is still in active development and may be subject to breaking changes! :warning:
That said, it is functional in its current state and I have been using it to log my flights, including
a recent trip from Minnesota to Alaska (shown in the screenshots above), which served as an extensive
test of its functionanlity.
## Getting Started <a name="getting_started"></a> ## Getting Started <a name="getting_started"></a>
### Docker <a name="docker"></a> ### Docker <a name="docker"></a>
|:exclamation: Note :exclamation: | |:exclamation: Warning :exclamation: |
|---------------------------------| |---------------------------------|
| Docker builds are considered unstable at this point and cannot be guaranteed to work without customization. Proceed at your own risk | | Docker builds are considered unstable at this point and cannot be guaranteed to work without customization. Proceed at your own risk |