diff --git a/README.md b/README.md new file mode 100644 index 0000000..38cd0a5 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +App deployed at : https://warblarblarg.herokuapp.com/ + + + +# 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 +