me/beerbuddy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated readme

Browse source
This commit is contained in:
ak 2023-12-12 16:37:50 -08:00
parent 675d294be7
commit 1ef08d16ef
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -9,17 +9,21 @@
Currently, the app is only available for download as an **Android APK**. Work is being undertaken to release iOS/PWA versions, as well as to get Beerbuddy on various app stores.
## Usage
## Getting Beerbuddy
To get started using Beerbuddy immediately, [download the APK release](https://codeberg.org/ak95/beerbuddy/releases/download/0.1/beerbuddy-0.1.apk). Or, to compile from source, please use the steps below.
## Compilation
To compile this app using EAS Build, navigate to the `react-native` directory and run `eas build -p android --profile [yourprofilename]`
## Usage
Once the app is downloaded and opened, the user will be brought to the default map screen. This screen is typically centered on the user's location.
Stores in the viewable region are represented as pins. Clicking on a pin will open a tooltip showing the stores name, cheapest item and cheapest item price per fluid ounce.
- Stores in the viewable region are represented as pins. Clicking on a pin will open a tooltip showing the stores name, cheapest item and cheapest item price per fluid ounce.
Clicking `more` on the pin will open up that store's page, which includes its name, picture as well as a list of all the store's items.
---
- Clicking `more` on the pin will open up that store's page, which includes its name, picture as well as a list of all the store's items.
- To update an item's price at the store, simply click on the pencil next to the item price and enter the new dollar amount.
@ -29,10 +33,6 @@ Clicking `more` on the pin will open up that store's page, which includes its na
- To search for products, simply tap in the search bar on the main map screen, search for your item and press the Enter key. This will display all products matching the queried name in a 50 mile radius. These results can then be sorted by distance, price, price per fluid ounce and time last updated. Tapping on a product will open the store page for the store carrying the product.
## Compilation
To compile this app using EAS Build, navigate to the `react-native` directory and run `eas build -p android --profile [yourprofilename]`
## Reporting Bugs
As this is an alpha release, bugs in the app are to be expected. Bug reports are welcomed [here](https://codeberg.org/ak95/beerbuddy/issues).