Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xinp-hub committed Feb 7, 2025
1 parent a5b9d4d commit b284ae6
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,20 @@
[![Build Status](https://github.com/xinp-hub/pydiggs/actions/workflows/ci.yml/badge.svg)](https://github.com/xinp-hub/pydiggs/actions/workflows/ci.yml)
[![Documentation Status](https://github.com/xinp-hub/pydiggs/actions/workflows/docs.yml/badge.svg)](https://xinp-hub.github.io/pydiggs/)
[![Updates](https://pyup.io/repos/github/xinp-hub/pydiggs/shield.svg)](https://pyup.io/account/repos/github/xinp-hub/pydiggs/)
[![GitHub Issues](https://img.shields.io/github/issues/xinp-hub/pydiggs.svg)](https://github.com/xinp-hub/pydiggs/issues)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

A Python package for Data Interchange for Geotechnical and Geoenvironmental Specialists (DIGGS).

* Licensed under the Apache License 2.0
* Documentation: [https://xinp-hub.github.io/pydiggs](https://xinp-hub.github.io/pydiggs)
* GitHub: [https://github.com/xinp-hub/pydiggs](https://github.com/xinp-hub/pydiggs)
* PyPI: [https://pypi.org/project/pydiggs](https://pypi.org/project/pydiggs)

## Project Lead

* Xin Peng (<xin_peng@outlook.com>)
* Asitha Senanayake (<asitha.senanayake@utexas.edu>)

## Features

Expand All @@ -25,6 +33,12 @@ A Python package for Data Interchange for Geotechnical and Geoenvironmental Spec
* Print validation errors directly to console
* Command-line interface (CLI) for easy integration

## Web Application

Not a Python user? Looking for leveraging the power of pyDIGGS in an modern web application? Check out:

* [DXplorer](https://dx-plorer.com)

## Quick Start

Install pydiggs:
Expand Down
6 changes: 6 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ A Python package for Data Interchange for Geotechnical and Geoenvironmental Spec
* Print validation errors directly to console
* Command-line interface (CLI) for easy integration

## Web Application

Not a Python user? Looking for leveraging the power of pyDIGGS in an modern web application? Check out:

* [DXplorer](https://dx-plorer.com)

## Quick Start

Install pydiggs:
Expand Down

0 comments on commit b284ae6

Please sign in to comment.