Updated documentation and license

Author: tdunlap607

README.md

@@ -1,9 +1,28 @@
 # PatchParser
 A python package to extract key features from a commit patch.
 
-***Please note this repository is still in the initial development phase.***
+Please note this repository is still in the initial development phase.
 
-## Features
+## Installation
+
+Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.
+
+```bash
+pip install patchparser
+```
+
+## Usage
+
+```python
+from patchparser import github_parser
+
+# Parse a given commit for a GitHub repository
+parsed = github_parser.commit(repo_owner="Lightning-AI",
+                              repo_name="lightning",
+                              sha="62f1e82e032eb16565e676d39e0db0cac7e34ace")
+```
+
+### Parsed Features
 
 |Columns             |Type|Description                                                                                |
 |--------------------|----|-------------------------------------------------------------------------------------------|
@@ -36,4 +55,12 @@ A python package to extract key features from a commit patch.
 |status              |str |GitHub status tag at file level (e.g., modified)                                           |
 |total_additions     |int |Total lines added for a file                                                               |
 |total_deletions     |int |Total lines deleted for a file                                                             |
-|total_changes       |int |Total lines changed for a file (total_additions + total_deletions)     
+|total_changes       |int |Total lines changed for a file (total_additions + total_deletions) 
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+[Unlicense](https://choosealicense.com/licenses/unlicense/)

pyproject.toml

@@ -6,17 +6,16 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "patchparser"
-version = "0.0.1"
+version = "0.0.2"
 authors = [
   { name="Trevor Dunlap", email="[email protected]" },
 ]
 description = "A python package to extract key features from a commit patch."
 readme = "README.md"
-license = { file="LICENSE" }
 requires-python = ">=3.7"
 classifiers = [
     "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
+    "License :: OSI Approved :: Unlicense",
     "Operating System :: OS Independent",
 ]