Skip to content

Commit c5a3a23

Browse files
committed
docs: update readme
1 parent 1456a87 commit c5a3a23

1 file changed

Lines changed: 34 additions & 7 deletions

File tree

README.md

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,41 @@
1-
# @devhaven/unit-conversion
1+
<p align="center">
2+
<h1 align="center">@devhaven/unit-conversion</h1>
3+
<p align="center">
4+
An SDK for unit conversion.
5+
<br/>
6+
by <a href="https://x.com/blank_riser">@blank_riser</a>
7+
</p>
8+
</p>
29

3-
An SDK for unit conversion.
410

5-
### How does it work?
11+
<p align="center">
12+
<a href="https://github.com/BlankRiser/unit-conversion/actions?query=branch%3Amain"><img src="https://github.com/BlankRiser/unit-conversion/actions/workflows/release.yml/badge.svg?event=push&branch=main" alt="Zod CI status" /></a>
13+
<a href="https://opensource.org/licenses/apache-2-0" rel="nofollow"><img src="https://img.shields.io/github/license/Blankriser/unit-conversion" alt="License"></a>
14+
</p>
615

7-
```ts
8-
const conversion = new Conversion();
916

10-
const result = conversion.value(10).from("meter").to("foot");
17+
## Features
18+
19+
- Zero external dependencies
20+
- Works in Node.js and all modern browsers
21+
- Concise interface
22+
- Works with TypeScript and plain JS
23+
24+
## Installation
25+
26+
```sh
27+
npm install @devhaven/unit-conversion
28+
pnpm add @devhaven/unit-conversion
29+
bun add @devhaven/unit-conversion
1130

12-
console.log(result);
31+
deno add jsr:@devhaven/unit-conversion
1332
```
1433

34+
### Basic Usage
35+
36+
```ts
37+
import { Conversion } from "@devhaven/unit-conversion"
38+
39+
const conversion = new Conversion();
40+
const result = conversion.value(10).from("meter").to("foot");
41+
```

0 commit comments

Comments
 (0)