Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zacbennett authored Jan 16, 2019
1 parent c2fb7b8 commit 923c01d
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
App deployed at : https://warblarblarg.herokuapp.com/

<a href="https://warblarblarg.herokuapp.com/"><img src="assets/Warbler_Landing_Page.png" title="WarBlarBlarg" alt="WarBlarBlarg"></a>

# Warblar - Twitter Clone

> Warblar is a twitter clone with full CRUD on 'warbles' or tweets. The site offers full features such as following/followers, sign up and authentication (encryption using bcrypt), warbles and more!
## Table of Contents

- [Installation](#installation)
- [Features](#features)
- [Team](#team)

## Installation

```shell
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
flask run
```


### Features
<ul>

<li>Users can sign up with a password protected account.</li>
<li>Users can "like", post and follow "warbles" or tweets.</li>
<li>Full unit and integration tests.</li>
<li>Passwords encrypted and stored in database.</li>
<li>Full CRUD on user profiles as well as "warbles".</li>
</ul>
<img src=”https://github.com/Lulzasaur/Warbler/raw/master/assets/Warbler_Home_Page.png”></img>

Team
| Victor Marks | github.com/silasburger |

0 comments on commit 923c01d

Please sign in to comment.