(patch) Update the README #1

Merged
pfm merged 4 commits from initialize-actions into main 2024-03-24 04:02:38 +00:00
Showing only changes of commit 117f9fa6e6 - Show all commits

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.