Skip to content

Commit

Permalink
Removed build and test sections from readme
Browse files Browse the repository at this point in the history
  • Loading branch information
james-pre committed Oct 15, 2023
1 parent 170f8f2 commit 5b3c0bc
Showing 1 changed file with 0 additions and 11 deletions.
11 changes: 0 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,6 @@ For more information, see the [API documentation](https://browser-fs.github.io/f
npm install @browserfs/fs-dom
```

## Building

- Make sure you have Node and NPM installed. You must have Node v18 or newer.
- Install dependencies with `npm install`
- Build using `npm run build`
- You can find the built code in `dist`.

## Usage

> 🛈 The examples are written in ESM. If you are using CJS, you can `require` the package. If running in a borwser you can add a script tag to your HTML pointing to the `browser.min.js` and use BrowserFS DOM via the global `BrowserFS_DOM` object.
Expand All @@ -46,7 +39,3 @@ if (!fs.existsSync('/test.txt')) {
const contents = fs.readFileSync('/test.txt', 'utf-8');
console.log(contents);
```

### Testing

Run unit tests with `npm test`.

0 comments on commit 5b3c0bc

Please sign in to comment.