Skip to content

Commit

Permalink
docs: improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
czabaj committed Aug 14, 2023
1 parent ba70f8f commit 43e0298
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# check.beer

A web application for "home pub" operation. It solves the following problems:
A web application for managing a _garage pub_. It solves the following problems:

- which keg is on which tap,
- how much beer is left in the tapped kegs,
- stored kegs management,
- how many kegs are there in the storage and who bough them,
- who is currently present and how many beers they consumed,
- accounting between keg investors and consumers concerning the net consumption from the keg. Say the keg of 100 beers costs 1000 credits, then one beer should cost 10 credits but there are always wastes, in reality, only around 95 beers are drafted and this app divides the _net_ consumption between consumers.

See for your selves on [check.beer](https://check.beer)
Expand All @@ -16,7 +17,7 @@ This app originates from an Android application "BeerBook", which I made _years_
## Developer facts of interest
- this app is written in [ReScript, a flavor of OCaml programming language](https://rescript-lang.org) which compiles to clean JavaScript,
- this app is a [progressive-web-app (PWA)](https://web.dev/learn/pwa/), it can be installed as a standalone app and is capable of running offline with almost no limitations,
- this app **runs on Firebase** and utilizes most of its goodies - offline support, near real-time synchronization, reliability and _infinite scalability_,
- this app **runs on Firebase** and utilizes most of its goodies - offline support, near real-time synchronization, low-cost operation and super reliability,
- this app is written in React using **Suspense for data-fetching**, RxJS is used to construct data-pipes for React components,
- this app uses vanilla CSS for styling with an emphasis on modern CSS features, like [Colors Module 4](https://developer.mozilla.org/en-US/blog/css-color-module-level-4/), [Logical Properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values), [Subgrid](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Subgrid) or [Anchor Positioning](https://developer.chrome.com/blog/tether-elements-to-each-other-with-css-anchor-positioning/), using modern layouts to _eschew screen-width media queries as much as possible_,
- appropriate HTML elements are used concerning accessibility (A11Y), the HTML structure is always shallow, _no extra `<div>` ever_,
Expand Down

0 comments on commit 43e0298

Please sign in to comment.