docs: update license and documentation

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing Guide
+
+For now, this is a personal project and I don't have any plans to support or
+publish it. That said, pull requests are accepted and I might change my mind
+if anybody else finds this project useful.
+
+## Getting started with local development
+
+These instructions assume that [Python 3](https://docs.python.org/3/) is
+installed in your system and available in the shell's command search path as
+`python3`.
+
+Once you have cloned this repository, create and activate a temporary virtual
+environment, and then install the required dependencies as follows:
+
+```
+python3 -m venv .venv
+. ./.venv/bin/activate
+pip install -r requirements.txt
+```
+
+You should now be able to start Python via `python -i .pythonrc` to explore this
+package and its documentation interactively.
+
+## Running unit and integration tests locally
+
+Ensure that the temporary virtual environment created for local development is
+active, and then execute the command `python -m unittest`.

LICENSE

@@ -1 +1,19 @@
-Copyright (c) 2022 Uwe Stuehler <[email protected]>
+Copyright (c) 2022 Uwe Stuehler <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,37 +1,46 @@
 # py-amazing-marvin
-An experimental Python 3 package providing an API client for [Amazing Marvin](https://amazingmarvin.com/).
 
-## Dependencies
+A Python 3 package providing a _very_ limited and experimental API client for [Amazing Marvin](https://amazingmarvin.com/).
 
-### Development
+## Features
 
-- [Python 3](https://docs.python.org/3/)
+- Retrieve some information about your account (`AmazingMarvinAPI.me`)
+- Get tasks and projects scheduled for today (`AmazingMarvinAPI.today_items`)
 
-Optionally:
+## Installation with pip
 
-- [direnv](https://direnv.net/)
+```
+pip install git+https://github.com/ustuehler/py-amazing-marvin
+```
 
-### Runtime
+## Usage
 
-- [Python 3](https://docs.python.org/3/)
-- [Active subscription](https://app.amazingmarvin.com/signup) and [API token](https://app.amazingmarvin.com/pre?api) for Amazing Marvin
+To use this package, you must have an [active subscription](https://app.amazingmarvin.com/signup) and [API token](https://app.amazingmarvin.com/pre?api) for Amazing Marvin.
 
-## Roadmap
+Example:
 
-- Basic API client with authentication and all documented endpoints
-- Experimental API client extending the basic API client to support
-  additional, high-level use cases
-- Additional, high-level use cases
-  - Marvin usage health data
-    - Estimation coverage: number of tasks estimated vs. non-estimated
-    - Estimation accuracy: over-/underestimation for all estimated and tracked
-      tasks
-    - Overall habit grade: an overall grade over all defined habits
-    - Overall goal completion
-    - ... and similar
+```python
+import os
+from amazing_marvin import AmazingMarvinAPI
 
-## License
+# Get your API token from somewhere
+api_token = os.environ['AMAZING_MARVIN_API_TOKEN']
+
+# Create an instance of the experimental API client
+client = AmazingMarvinAPI(api_token)
+
+# Retrieve some information about your account
+client.me()
+
+# Get tasks and projects scheduled for today
+client.today_items()
+```
 
-[//]: # (TODO: select a license, audit, and publish the package on PyPi)
+## Contributing
+
+See the [Contributing Guide](CONTRIBUTING.md) for instructions on how to set up
+a local environment for development and testing.
+
+## License
 
-[Copyright © 2022 Uwe Stuehler (UNLICENSED)](LICENSE)
+[MIT](LICENSE)