Skip to content

Commit

Permalink
docs(uri): 📝 improve package docs
Browse files Browse the repository at this point in the history
  • Loading branch information
avchugaev committed Sep 22, 2022
1 parent 38d24ce commit 17d732a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
11 changes: 6 additions & 5 deletions packages/uri/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
## `@monument/uri`

A set of pure functions and types useful in any application.
URI parsing, serializing, modification, resolution and introspection functions.

![Build](https://img.shields.io/github/workflow/status/monumentjs/workspace/Release?logo=github)
![License](https://img.shields.io/github/license/monumentjs/workspace?logo=github)
![NPM version](https://img.shields.io/npm/v/@monument/uri?logo=npm)
![NPM dependencies](https://img.shields.io/librariesio/release/npm/@monument/uri?logo=npm)
[![Build](https://img.shields.io/github/workflow/status/monumentjs/workspace/Release?logo=typescript&logoColor=white)](https://github.com/monumentjs/workspace/actions)
[![Test](https://img.shields.io/github/workflow/status/monumentjs/workspace/Release?logo=jest&label=test)](https://github.com/monumentjs/workspace/actions)
[![Lint](https://img.shields.io/github/workflow/status/monumentjs/workspace/Release?logo=eslint&label=lint)](https://github.com/monumentjs/workspace/actions)
[![License](https://img.shields.io/github/license/monumentjs/workspace?logo=github)](/LICENSE)
[![NPM version](https://img.shields.io/npm/v/@monument/uri?logo=npm&label=version&logoColor=white)](https://www.npmjs.com/package/@monument/uri)

## Install

Expand Down
1 change: 1 addition & 0 deletions packages/uri/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"url": "https://github.com/monumentjs/workspace.git",
"directory": "packages/uri"
},
"license": "MIT",
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md"
Expand Down

0 comments on commit 17d732a

Please sign in to comment.