Skip to content

Commit 84ea050

Browse files
committed
Update Readme
1 parent afcb5de commit 84ea050

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

readme.md

+8-14
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,18 @@ You can install the library with npm:
1212
npm install @zellwk/javascript
1313
```
1414

15-
Then import whatever functions you need by traversing the folders. When importing, you can skip the `src` path because that is already handled for you in the `package.json` file.
15+
All files are found within there folders:
16+
17+
- `browser` — usable only in browsers
18+
- `node` — usable only in Node
19+
- `utils` — usable in both browsers and node
20+
21+
Just import whatever file you need from these folders. When importing, you can skip the `src` path because that is already handled for you in the `package.json` file.
1622

1723
Example for using Local Store:
1824

1925
```js
20-
import * as localStore from '@zellwk/javascript/browser/local-store'
26+
import * as localStore from '@zellwk/javascript/browser/local-store.js'
2127
```
2228

2329
## Installation and usage without npm
@@ -34,18 +40,6 @@ import localStore from 'https://cdn.jsdelivr.net/npm/@zellwk/javascript@3.0.0/sr
3440

3541
See [this article](https://zellwk.com/blog/node-modules-in-frontend-without-bundlers/) to make this nicer for your project.
3642

37-
## What's here?
38-
39-
You can explore the `src` folder to find what's available.
40-
41-
These functions are categorized according to the following folders:
42-
43-
- `browser` — Browser-only stuff
44-
- `node` — Node-only stuff
45-
- `utils` — Things that work on both browser and Node
46-
47-
You will find documentation for each utility in their respective readme files.
48-
4943
## WIP Warning
5044

5145
This repository is always a Work in Progress. I may change anything anytime!

0 commit comments

Comments
 (0)