Skip to content

Commit

Permalink
docs: updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kazupon committed Sep 21, 2023
1 parent ea08f8a commit 0a56988
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Internationalization API

## πŸ’Ώ Installation

### Node.js
### 🐒 Node.js

```sh
# Using npm
Expand Down Expand Up @@ -53,7 +53,7 @@ avoid hoisting issues.

</details>

### Deno
### πŸ¦• Deno

You can install via `import`.

Expand All @@ -66,7 +66,7 @@ mod.ts:

```ts
/**
* you can install via other CDN URL such skypack,
* you can install via other CDN URL such as skypack,
* or, you can also use import maps
* https://docs.deno.com/runtime/manual/basics/import_maps
*/
Expand All @@ -88,27 +88,40 @@ import { ... } from 'https://esm.sh/@intlify/utils-edge'

</details>

### Bun
### πŸ₯Ÿ Bun

```sh
bun install @intlify/utils
```

### Browser
### 🌍 Browser

```html
<script type="module">
/**
* you can install via other CDN URL such skypack,
* you can install via other CDN URL such as skypack,
* or, you can also use import maps
*/
import { isLocale } from 'https://esm.sh/@intlify/utils'
// Somothing todo
// something todo
// ...
</script>
```

## 🍭 Playground

You can play the below examples:

- 🐒 [Node.js](https://github.com/intlify/utils/tree/main/examples/node):
`npm run play:node`
- πŸ¦• [Deno](https://github.com/intlify/utils/tree/main/examples/deno):
`npm run play:deno`
- πŸ₯Ÿ [Bun](https://github.com/intlify/utils/tree/main/examples/bun):
`npm run play:bun`
- 🌍 [Browser](https://github.com/intlify/utils/tree/main/examples/browser):
`npm run play:browser`

## πŸ”¨ Utilities

### Common
Expand All @@ -128,7 +141,7 @@ You can do `import { ... } from '@intlify/utils'` the above utilities

You can do `import { ... } from '@intlify/utils/{ENV}'` the above utilities.

`ENV` is one of the following:
The namespace `{ENV}` is one of the following:

- `node`: Node.js
- `web`: JS environments (such as Deno, Bun, and Browser) supporting Web APIs
Expand Down

0 comments on commit 0a56988

Please sign in to comment.