garrity-software/gs-slug
1
0
Fork 0
Code Issues Pull requests Releases Activity Actions

(patch) Update the README
Some checks failed
/ Build and Test Library Snapshot (pull_request) Failing after 41s
Details

Browse source
This commit is contained in:
Pat Garrity 2024-03-23 22:52:46 -05:00
parent cfcbfdfdac
commit 117f9fa6e6
Signed by: pfm
GPG key ID: 5CA5D21BAB7F3A76
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -17,3 +17,23 @@ externalResolvers +=
val GsSlug: ModuleID =
"gs" %% "gs-slug-v0" % "0.1.0"
```
## Slug Type
`Slug` is the type exposed by this library. It is an extremely small,
restricted, opaque type (`String`) that adheres to the following regular
expression:
```
^[a-z0-9]+(?:\-[a-z0-9]+)*$
```
This type is intended for use in the following scenarios:
- Restricted ASCII is acceptable.
- URL safety is desired.
Additionally, `Slug` is usually intended to be unique within some _context_,
where the implementation defines the context. For example, if some organization
owns a number of repositories, each repository might have a `Slug` which is
unique within that organization.