Skip to content

Commit

Permalink
docs(pee): Update docs for accessibility and remove false (at very le…
Browse files Browse the repository at this point in the history
…ast not quite true)

both cjs and mjs version can run on browser and node
  • Loading branch information
jukefr committed Mar 30, 2022
1 parent 674dde8 commit 3299692
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Pee.js
![Pee.js Logo](logo.png)
![Pee.js Logo, it says meow uwu pee.js ovo nya](logo.png)
> Piss away your memories...
# What is it?
Expand All @@ -10,20 +10,20 @@ I wanted to make a JavaScript library named pee.js because of a typo and a pun.

## Usage

This is a hybrid (commonjs and ecmascript module) package that is available on https://www.npmjs.com/package/pee.js
This is a hybrid package (commonjs and ecmascript module) that is available on the [node package manager registry](https://www.npmjs.com/package/pee.js)
```shell
# To install the package in your project
npm install --save pee.js
```

### Browser [ecmascript] (pee.js)
### Ecmascript (pee.js)
```js
import { leak } from 'pee.js';
leak(69); // Leaks 69 MB of memory
```
See `test/pee.test.js` for a more in-depth example

### Node [commonjs] (pee.cjs)
### Commonjs (pee.cjs)
```js
const { leak } = require('pee.js');
leak(420); // Leaks 420 MB of memory
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "pee.js",
"version": "2.0.1",
"version": "2.0.2",
"description": "A javascript Library for leaking memory",
"type": "module",
"main": "pee.cjs",
Expand Down

0 comments on commit 3299692

Please sign in to comment.