Skip to content

Commit

Permalink
chore: add proper readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mclaughlinconnor authored Apr 29, 2022
1 parent 87fbeee commit 54e75b9
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,36 @@
# FP
![Banner](assets/images/feature-big.png)

<h1 align="center">✒️ FP ✒️</h1>
<h3 align="center">Fountain Pen and Ink Inventory</h3>

## Motivation

I have too many pens and too many inks, and the problem is that I am afflicted with not only being human, but also being colour blind.

These two things together mean that I can never remember what ink is in which pen, nor can I figure it out by looking.

FP inventories all pens, inks and nibs along with their associations to each other.
## Features

The current feature set is pretty limited seeing as this project was created to satisfy my own need

- List all:
- Pens
- Inks
- Nibs
- Track the associations between all of your different pens, inks, and nibs
- Sync between all of your mobile devices in real time
- Add images and other metadata to pens, inks, and nibs
- Seemless over the air updates
- Searching by all properties, including whether a pen is currently inked or not

## Disclaimer

I built this for my own needs and it seems to work pretty well for that; however, I have tried to make sure it will work well for other users too.
With this in mind, though, bugs are _likely_.

Please open an issue if you find any bugs (or for feature requests) and I'll try to fit it in around work and university

## Releases

The most recent APK will be in the releases.
If there is not a release corresponding to the most recent master release, **this is fine** -- FP uses wireless OTA updates so updates will be downloaded on your device after the APK is installed.

0 comments on commit 54e75b9

Please sign in to comment.