Merge pull request #20 from joon0110/hw6

Hw6: doc prep and version update

CONTRIBUTING.md

@@ -1 +1,11 @@
-TODO
+## Prerequisites
+
+Clone the repository from github with git clone command, and install dependencies using `make develop`.  
+
+## Making changes
+
+Please make changes with descriptive commit messages and create tests for new codes you created. Lint and autoformat your code using 'make lint' and 'make format'. 
+
+# Contribution Guidelines
+
+Create a PR to the main and write down what you changed and how it works in the comment section.

README.md

@@ -10,13 +10,10 @@ scranking is a python library that display ranking of the college swimmer
 
 ## Overview
 
-ranking.py is a pyhton library that calculates and illustrate the ranks of college swimmer.
+Scranking is a library that scrapes data from a website such as [swimcloud](https://www.swimcloud.com/swimmer/549377/), which is website that shows times and ranking of the college swimmer. 
 
-Only highschool swimmers have the rank illustrated on their profile. Unlike the highschool swimmers, college swimmers don't.
+The library will allow users to simpily type the URL and get all the neccessary information of that swimmer.
 
-- [highschool swimmer](https://www.swimcloud.com/swimmer/1156452/)
-- [college swimmer](https://www.swimcloud.com/swimmer/549377/)
-
-
-Maybe I am changing to Columbia Graduate Calculator where it is a python library helps the student to be on track to graudate
+## Install
 
+Install using 'pip install scranking' in the command line.

pyproject.toml

@@ -11,7 +11,7 @@ name = "scranking"
 authors = [{name = "Joon Ahn", email = "[email protected]"}]
 description="scranking is a python library that display ranking of the college swimmer"
 readme = "README.md"
-version = "0.0.1"
+version = '0.1.1'
 requires-python = ">=3.8"
 
 dependencies = []

scranking/_version.py

@@ -1 +1 @@
-__version__ = "0.0.1"
+__version__ = '0.1.1'