Skip to content

Commit

Permalink
Document app concept in README
Browse files Browse the repository at this point in the history
  • Loading branch information
fabiante committed Sep 2, 2023
1 parent 195a525 commit cbb569c
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,19 @@

Application to manage and resolve [PURL](https://en.wikipedia.org/wiki/Persistent_uniform_resource_locator) links.

## PURL Support
## Documentation

Until the documentation becomes large enough, this README will be used to
documentation features and concepts.

### Concept

The application handles PURL domains. A domain is a collection of PURLs which
you can think of as shortened URLs. When opened in a browser (a GET request),
PURLs forward the user to the target URL which is configured by the PURLs
maintainer.

### PURL Support

This project tries it's best to implement PURL support as it can be understood
from a couple of hours researching the topic on the web. It is possible that
Expand Down

0 comments on commit cbb569c

Please sign in to comment.