documentation updates

Signed-off-by: Andrew Whitehead <[email protected]>

Author: andrewwhitehead

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+## How to contribute
+
+You are encouraged to contribute to the repository by **forking and submitting a pull request**.
+
+For significant changes, please open an issue first to discuss the proposed changes to avoid re-work.
+
+(If you are new to GitHub, you might start with a [basic tutorial](https://help.github.com/articles/set-up-git) and check out a more detailed guide to [pull requests](https://help.github.com/articles/using-pull-requests/).)
+
+Pull requests will be evaluated by the repository guardians on a schedule and if deemed beneficial will be committed to the master. Pull requests should have a descriptive name and include an summary of all changes made in the pull request description.
+
+If you would like to propose a significant change, please open an issue first to discuss the work with the community.
+
+All contributors retain the original copyright to their stuff, but by contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users **under the terms of the license under which this project is distributed.**

README.md

@@ -1,10 +1,10 @@
 # indy-shared-rs
 
-Shared Rust data types and utility functions for Hyperledger Indy.
+Shared Rust libraries for Hyperledger Indy.
 
 - `indy-credx`: Indy verifiable credential issuance and presentation (aka Anoncreds)
 
-- `indy-data-types`: Struct definitions for Schemas, Credential Definitions and other
+- `indy-data-types`: Data type definitions for Schemas, Credential Definitions and other
   types related to credential issuance and processing
 
 - `indy-test-utils`: Utilities for use in integration tests.
@@ -14,3 +14,17 @@ Shared Rust data types and utility functions for Hyperledger Indy.
   language) expressions, normalizing transactions for signing, deriving DIDs and
   verification keys, and packing and unpacking agent messages using the DIDComm
   v1 envelope format.
+
+## Credit
+
+The initial implementation of `indy-shared-rs` was developed by the Verifiable Organizations Network (VON) team based at the Province of British Columbia, and derives largely from the implementations within [Hyperledger Indy-SDK](https://github.com/hyperledger/indy-sdk). To learn more about VON and what's happening with decentralized identity in British Columbia, please go to [https://vonx.io](https://vonx.io).
+
+## Contributing
+
+Pull requests are welcome! Please read our [contributions guide](https://github.com/bcgov/indy-shared-rs/blob/master/CONTRIBUTING.md) and submit your PRs. We enforce [developer certificate of origin](https://developercertificate.org/) (DCO) commit signing. See guidance [here](https://github.com/apps/dco).
+
+We also welcome issues submitted about problems you encounter in using `indy-shared-rs`.
+
+## License
+
+[Apache License Version 2.0](https://github.com/bcgov/indy-shared-rs/blob/master/LICENSE)

wrappers/python/README.md

@@ -0,0 +1,19 @@
+# Indy-Credx
+
+[![pypi releases](https://img.shields.io/pypi/v/indy_credx)](https://pypi.org/project/indy-credx/)
+
+A Python wrapper around the `indy-credx` Rust library, this module provides support for Hyperledger Indy "Anoncreds" verifiable credential issuance, presentation, and verification.
+
+## Credit
+
+The initial implementation of Indy-Credx was developed by the Verifiable Organizations Network (VON) team based at the Province of British Columbia, and derives largely from the implementation within [Hyperledger Indy-SDK](https://github.com/hyperledger/indy-sdk). To learn more about VON and what's happening with decentralized identity in British Columbia, please go to [https://vonx.io](https://vonx.io).
+
+## Contributing
+
+Pull requests are welcome! Please read our [contributions guide](https://github.com/bcgov/indy-shared-rs/blob/master/CONTRIBUTING.md) and submit your PRs. We enforce [developer certificate of origin](https://developercertificate.org/) (DCO) commit signing. See guidance [here](https://github.com/apps/dco).
+
+We also welcome issues submitted about problems you encounter in using Indy-Credx.
+
+## License
+
+[Apache License Version 2.0](https://github.com/bcgov/indy-shared-rs/blob/master/LICENSE)

wrappers/python/setup.py

@@ -1,16 +1,22 @@
 """Module setup."""
 
+import os
 import runpy
 from setuptools import find_packages, setup
 
 PACKAGE_NAME = "indy_credx"
 version_meta = runpy.run_path("./{}/version.py".format(PACKAGE_NAME))
 VERSION = version_meta["__version__"]
 
+with open(os.path.abspath("./README.md"), "r") as fh:
+    long_description = fh.read()
+
 if __name__ == "__main__":
     setup(
         name=PACKAGE_NAME,
         version=VERSION,
+        long_description=long_description,
+        long_description_content_type="text/markdown",
         url="https://github.com/bcgov/indy-shared-rs",
         packages=find_packages(),
         include_package_data=True,