Merge pull request #2 from fair-data-austria/dev

Basic Functionality

.gitignore

@@ -5,6 +5,9 @@ __pycache__/
 # Idea software family
 .idea/
 
+# VS Code
+.vscode/
+
 # C extensions
 *.so
 

MANIFEST.in

@@ -34,3 +34,6 @@ recursive-include docs Makefile
 recursive-include invenio_madmp *.html
 recursive-include invenio_madmp *.py
 recursive-include tests *.py
+
+# added by check_manifest.py
+recursive-include tests *.json

README.rst

@@ -17,15 +17,39 @@
 .. image:: https://img.shields.io/github/tag/fair-data-austria/invenio-madmp.svg
         :target: https://github.com/fair-data-austria/invenio-madmp/releases
 
-.. image:: https://img.shields.io/pypi/dm/invenio-madmp.svg
-        :target: https://pypi.python.org/pypi/invenio-madmp
-
 .. image:: https://img.shields.io/github/license/fair-data-austria/invenio-madmp.svg
         :target: https://github.com/fair-data-austria/invenio-madmp/blob/master/LICENSE
 
-Invenio module for maDMP integration.
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/psf/black
+
+
+Invenio module for integrating machine-actionable data management plans (maDMPs)
+according to the `Research Data Alliance Common Standard <https://github.com/RDA-DMP-Common/RDA-DMP-Common-Standard>`_.
+
+
+The aim of this module is to support researchers in depositing their research data
+in accordance with their data management plans (DMPs) by exchanging maDMPs
+with external DMP tools.
+
+
+Since some of the information that is relevant as metadata for records is already
+defined in the DMPs for their research projects, it is only natural to use DMPs
+as a source for partially pre-filled metadata.
+
+
+
+Features:
+
+* Workflows for parsing maDMPs and creating new record drafts with pre-filled metadata
+  from the parsed information, or updating the metadata of already existing records
+  (respectively, drafts)
+* Generic RecordConverter class for translating between maDMP datasets (respectively,
+  distributions) and records (and drafts) in Invenio, intended to be subclassed to
+  match custom metadata models
+* REST endpoints for communication with external DMP tools
+
 
-TODO: Please provide feature overview of module
 
 Further documentation is available on
 https://invenio-madmp.readthedocs.io/