Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
Prepared for the addition of screenshots
  • Loading branch information
paulpall authored Mar 28, 2021
1 parent 051b828 commit 2b8e5f6
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,42 @@
# About



Sortify is an app that helps you recycle . In many cases people don’t recycle because it can be hard to know how to dispose of things correctly . Sortify solves this problem by sorting out your recycling for you . Simply take a picture of the item and the app will provide you with recycling instructions .
<p align="center">
<img src="/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png" alt="Sortify App Icon" />

# About

Sortify is an app that helps you recycle. In many cases people don’t recycle because it can be hard to know how to dispose of things correctly. Sortify solves this problem by sorting out your recycling for you. Simply take a picture of the item and the app will provide you with recycling instructions.

# Getting Started

The Test Release of the app can be found [here](https://github.com/paulpall/Sortify/releases)! Follow the instructions provided on the page .
The Test Release of the app can be found [here](https://github.com/paulpall/Sortify/releases)! Follow the instructions provided on the page.

# Usage

## Start Screen:

When the app is started you will be faced with two options. Sortify Discover™ that lists all known recyclable objects along with the respective recycling guidances; and Sortify Camera™ that lets the user capture an object & provides relevant information in return.

<p align="center">
<img src="/screenshots/Screenshot_Start.png" alt="Screenshot of the Start View" style="zoom:25%;" />



## Sortify Discover:

In the Discover view the user can scroll up and down to browse through different recyclable items.

<p align="center">
<img src="/screenshots/Screenshot_Discover.png" alt="Screenshot of the Discover Results View" style="zoom:25%;" />

## Sortify Camera:

In the Camera view it first goes to the phone's camera to take a picture . Once the picture has been taken the app gives possible items in the picture and how to recycle them .
In the Camera view it first goes to the phone's camera to take a picture. Once the picture has been taken the app gives possible items in the picture and how to recycle them.

<p align="center">
<img src="/screenshots/Screenshot_Camera.png" alt="Screenshot of the Camera Results View" style="zoom:33%;" />

# License

Distributed under the MIT License. See [`LICENSE`](https://github.com/paulpall/Sortify/blob/master/LICENSE) for more information.
Distributed under the MIT License. See [`LICENSE`](LICENSE) for more information.

# Contact

Expand Down

0 comments on commit 2b8e5f6

Please sign in to comment.