Skip to content

Commit

Permalink
Merge pull request #82 from thkruz/update-readme
Browse files Browse the repository at this point in the history
Added information on ES5 vs ES6+
  • Loading branch information
ezze committed Dec 25, 2020
2 parents 4626ff5 + ea28d25 commit c726d15
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Expand Up @@ -301,6 +301,14 @@ These is a full list of all available NPM scripts:
COVERALLS_REPO_TOKEN=<token> npm run test:coveralls
```

## ES5 and satellite.min.js

Some people are confused that they can't just download a single satellite.js or satellite.min.js file. That is because satellite.js is not written in plain old JavaScript (ES5) anymore but ported to latter JavaScript versions ES6+.

Only the "src" directory is included in the Git repository, "dist" and "lib" directories are ignored. It's done intentionally to retain the size of the repository as small as possible. A full detailed explanation of why is located [here](https://github.com/shashwatak/satellite-js/issues/80#issuecomment-749225324).

You should install satellite.js with your package manager (npm or yarn) and then find satellite.js and satellite.min.js in node_modules/satellite.js/dist directory.

## TODO

Optional functions that utilize Worker Threads
Expand Down

0 comments on commit c726d15

Please sign in to comment.