Skip to content

Commit

Permalink
Merge pull request #129 from BritishGeologicalSurvey/docs-revised
Browse files Browse the repository at this point in the history
  • Loading branch information
KoalaGeo authored Dec 7, 2023
2 parents 72fe49e + de56beb commit ddda397
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
![GitHub last commit](https://img.shields.io/github/last-commit/BritishGeologicalSurvey/pyagsapi?style=for-the-badge)
![GitHub contributors](https://img.shields.io/github/contributors/BritishGeologicalSurvey/pyagsapi?style=for-the-badge)


A HTTP API for the [AGS Python library](https://gitlab.com/ags-data-format-wg/ags-python-library).

It can:
Expand All @@ -29,6 +28,8 @@ It is built on the FastAPI framework, using the official FastAPI Docker image.

The core Python API provides the functionality to validate and convert AGS geotechnical data. From here, standard Python web frameworks like Uvicorn and Starlette provide the web API/wrapper atop the core Python API.

BGS Deployed Instance available at: [https://agsapi.bgs.ac.uk/](https://agsapi.bgs.ac.uk/)

## Quick start

### Docker
Expand Down
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ It is built on the FastAPI framework, using the official FastAPI Docker image.

The core Python API provides the functionality to validate and convert AGS geotechnical data. From here, standard Python web frameworks like Uvicorn and Starlette provide the web API/wrapper atop the core Python API.

BGS Deployed Instance available at: [https://agsapi.bgs.ac.uk/](https://agsapi.bgs.ac.uk/)

## Quick start

### Docker
Expand Down

0 comments on commit ddda397

Please sign in to comment.