Skip to content

Commit 38ae2e1

Browse files
committed
Update Readme after repo name change and updating some links
1 parent 7e79ea2 commit 38ae2e1

File tree

1 file changed

+9
-17
lines changed

1 file changed

+9
-17
lines changed

README.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,17 @@
11
# Gramps Web API
22

3-
RESTful web API for [Gramps](https://gramps-project.org).
3+
This is the repository for **Gramps Web API**, a Python REST API for [Gramps](https://gramps-project.org).
44

5-
**Users of *Gramps Web*, please see the [Gramps Web documentation site](https://www.grampsweb.org/) for details on setup, usage, where to get help, and how to contribute.**
5+
It allows to query and manipulate a [Gramps](https://gramps-project.org) family tree database via the web.
66

7-
## Description
7+
Gramps Web API is the backend of [Gramps Web](https://www.grampsweb.org/), a genealogy web app based on Gramps, but can also be used as backend for other tools.
88

9-
This project provides a RESTful web API to query and manipulate a [Gramps](https://gramps-project.org) family tree database. It can serve e.g. as backend for a web app. Gramps Web API is the backend powering [Gramps Web](https://www.grampsweb.org/).
9+
## More information
1010

11-
## API documentation
11+
- API documentation for Gramps Web API: https://gramps-project.github.io/gramps-web-api/
12+
- Developer documentation for Gramps Web API: https://www.grampsweb.org/dev-backend/
13+
- Documentation for Gramps Web: https://www.grampsweb.org
1214

13-
The documentation of the current state of the API can be browsed with Swagger:
15+
## Related projects
1416

15-
[Gramps API docs](https://gramps-project.github.io/gramps-web-api/)
16-
17-
The project is still under development, so API changes should be expected.
18-
19-
## Developer documentation
20-
21-
The project's development documentation is hosted at https://www.grampsweb.org/dev-backend/.
22-
23-
## Demo Server
24-
25-
See the documentation site for a link to the demo server.
17+
- Gramps Web frontend repository: https://github.com/gramps-project/gramps-web

0 commit comments

Comments
 (0)