Skip to content

Commit

Permalink
docs ~ README polish
Browse files Browse the repository at this point in the history
  • Loading branch information
rivy committed Jan 15, 2021
1 parent 57d7bba commit e2029bc
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,17 @@ console.log(osPaths.temp());
With `v5.0`+, `OSPaths` has been converted to a TypeScript-based module.
As a consequence, TypeScript type definitions are automatically generated, bundled, and exported by the module.

### Deno

`OSPaths` also fully supports use by Deno.

```js deno
import osPaths from 'https://cdn.jsdelivr.net/gh/rivy/js.os-paths@latest/src/mod.deno.ts';

console.log(osPaths.home());
console.log(osPaths.temp());
```

## Building and Contributing

[![Repository][repository-image]][repository-url]
Expand All @@ -139,7 +150,7 @@ As a consequence, TypeScript type definitions are automatically generated, bundl

### Build requirements

- NodeJS >= 6.0
- NodeJS >= 10.14
- a JavaScript package/project manager ([`npm`](https://www.npmjs.com/get-npm) or [`yarn`](https://yarnpkg.com))

> #### optional
Expand Down

0 comments on commit e2029bc

Please sign in to comment.