Updated readme

frictionlessdata · Dec 17, 2023 · ca84453 · ca84453
1 parent ffb087c
commit ca84453
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/.github/workflows/general.yaml b/.github/workflows/general.yaml
@@ -91,7 +91,7 @@ jobs:
       - name: Prepare environment
         run: pip3 install hatch
       - name: Build docs
-        run: hatch run docs
+        run: hatch run build
       - name: Publush to Github Pages
         uses: JamesIves/github-pages-deploy-action@v4
         with:

diff --git a/README.md b/README.md
@@ -6,3 +6,13 @@
 [![Release](https://img.shields.io/pypi/v/dplib-py.svg)](https://pypi.python.org/pypi/dplib-py)
 
 Python implementation of the Data Package standard and various tools for working with data
+
+## Purpose
+
+The Data Package Library is a lightweight Data Package Standard implementation in Python providing Pydantic data models and various metadata converters. At the moment, the main purpose of this library is to be used as an underlying component of Data Package based integrations.
+
+## Documentation
+
+Please visit the documentation portal:
+
+- https://frictionlessdata.github.io/dplib-py/