Update README.md

Author: Shaun B

README2.md

@@ -0,0 +1,103 @@
+# Article Summarizer
+> Article Summarizer is an asynchronous RESTful API built with Python and FastAPI. It utilizes Newspaper3k to provide real-time text summarization from a given URL. 
+
+![CI/CD][gh-actions-image]
+
+## Development setup
+
+First, install the system dependencies:
+* [docker](https://docs.docker.com/)
+* [docker-compose](https://docs.docker.com/compose/)
+* [git](https://git-scm.com/)
+* [make](https://www.gnu.org/software/make/)
+
+Second, download the source code
+```sh
+git clone https://github.com/sbathgate/fastapi-tdd-docker.git
+cd fastapi-tdd-docker/
+```
+
+Third, build the project image. 
+```sh
+make build
+```
+
+## Technologies
+* Python 3.8
+* FastAPI 
+* PostgreSQL
+* Heroku
+* Gunicorn 
+* Tortoise-ORM 
+* Newspaper3k
+* Pytest
+* Black 
+* Flake8
+* iSort
+
+## File Structure
+### Within the download you'll find the following directories and files:
+```
+├── .github
+│   └── workflows
+│       └── main.yml
+├── .gitignore
+├── README.md
+├── docker-compose.yml
+├── makefile
+├── project
+│   ├── .coverage
+│   ├── .coveragerc
+│   ├── .dockerignore
+│   ├── Dockerfile
+│   ├── Dockerfile.prod
+│   ├── app
+│   │   ├── __init__.py
+│   │   ├── api
+│   │   │   ├── __init__.py
+│   │   │   ├── crud.py
+│   │   │   ├── ping.py
+│   │   │   └── summaries.py
+│   │   ├── config.py
+│   │   ├── db.py
+│   │   ├── main.py
+│   │   ├── models
+│   │   │   ├── __init__.py
+│   │   │   ├── pydantic.py
+│   │   │   └── tortoise.py
+│   │   └── summarizer.py
+│   ├── db
+│   │   ├── Dockerfile
+│   │   └── create.sql
+│   ├── entrypoint.sh
+│   ├── htmlcov
+│   ├── requirements-dev.txt
+│   ├── requirements.txt
+│   ├── setup.cfg
+│   └── tests
+│       ├── __init__.py
+│       ├── conftest.py
+│       ├── test_ping.py
+│       ├── test_summaries.py
+│       └── test_summaries_unit.py
+└── release.sh
+```
+
+## Release History
+
+* 0.1.0
+    * Initial release
+
+## Acknowledgements
+This project wouldn't have been possible without the excellent [Test-Driven Development with FastAPI and Docker course](https://testdriven.io/courses/tdd-fastapi/) developed by [Michael Herman](https://mherman.org/) on [testdriven.io](https://testdriven.io). You can also find a free tutorial on their blog [Developing and Testing an Asynchronous API with FastAPI and Pytest](https://testdriven.io/blog/fastapi-crud/).
+
+## Contributing
+
+1. Fork it (<https://github.com/sbathgate/article-summarizer/fork>)
+2. Create your feature branch (`git checkout -b feature/fooBar`)
+3. Commit your changes (`git commit -am 'Add some fooBar'`)
+4. Push to the branch (`git push origin feature/fooBar`)
+5. Create a new Pull Request
+
+<!-- Markdown link & img dfn's -->
+[gh-actions-image]: https://github.com/sbathgate/fastapi-tdd-docker/workflows/CI/badge.svg?branch=master

makefile

@@ -1,27 +1,32 @@
-default: help
+default: build
+
+build: ## Build the docker containers
+	docker-compose build
+	rebuild-db
+	test
 
 help:  ## Output available commands
 	@echo "Available commands:"
 	@echo
 	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'
 
-lint-check:
+lint-check:  ## Conduct lint checks
 	@docker-compose exec web flake8 .
 	@echo "flake8 complete!"
 	@docker-compose exec web black . --check
 	@echo "black complete!"
 	@docker-compose exec web /bin/sh -c "isort ./**/*.py --check-only"
 	@echo "isort complete!"
 
-lint-correct:
+lint-correct:  ## Correct lint issues
 	@docker-compose exec web flake8 .
 	@echo "flake8 complete!"
 	@docker-compose exec web black .
 	@echo "black complete!"
 	@docker-compose exec web /bin/sh -c "isort ./**/*.py"
 	@echo "isort complete!"
 
-lint-diff:
+lint-diff:  ## Display differences in lint
 	@docker-compose exec web flake8 .
 	@echo "flake8 complete!"
 	@docker-compose exec web black . --diff
@@ -40,12 +45,15 @@ rebuild:  ## Rebuild docker images
 rebuild-db:  ## Rebuild db in docker image
 	@docker-compose exec web python app/db.py
 
+start:  # Start docker containers
+	@docker-compose up -d
+
 test: ## Run the current test suite
 	@docker-compose exec web python -m pytest --cov="."
 
 test-routes:  ## Test routes using HTTPie 
-	@http GET https://immense-island-91665.herokuapp.com/summaries/
-	@http GET https://immense-island-91665.herokuapp.com/summaries/1/
-	@http --json POST https://immense-island-91665.herokuapp.com/summaries/ url=https://shaunb.ca
-	@http --json PUT https://immense-island-91665.herokuapp.com/summaries/3/ url=https://shaunb.ca summary=super
-	@http DELETE https://immense-island-91665.herokuapp.com/summaries/3/
+	@echo "Get all: http GET <HOST_URL>/summaries/"
+	@echo "Get one: http GET <HOST_URL>/summaries/<id>"
+	@echo "Add Summary: http --json POST <HOST_URL>/summaries/ url=https://shaunb.ca"
+	@echo "Change Summary: http --json PUT <HOST_URL>/summaries/ url=https://shaunb.ca summary=super"
+	@echo "Get one: http DELETE <HOST_URL>/summaries/<id>"