Skip to content

Commit

Permalink
doc: update document for badge
Browse files Browse the repository at this point in the history
  • Loading branch information
izure1 committed Nov 20, 2024
1 parent b80cf8a commit 8b0e8e5
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Ryoiki

[![](https://data.jsdelivr.com/v1/package/npm/ryoiki/badge)](https://www.jsdelivr.com/package/npm/ryoiki)
![Node.js workflow](https://github.com/izure1/ryoiki/actions/workflows/node.js.yml/badge.svg)

`Ryoiki` is a JavaScript library that provides read/write locks based on specific ranges.
This library helps maintain consistency and stability by controlling concurrent access to data.

Expand All @@ -9,6 +12,12 @@ This library helps maintain consistency and stability by controlling concurrent
npm install ryoiki
```

or

```typescript
import { Ryoiki } from 'https://cdn.jsdelivr.net/npm/ryoiki@1/+esm'
```

## 🚀 Usage

### Basic Example
Expand Down

0 comments on commit 8b0e8e5

Please sign in to comment.