-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update install details, replace old rawgit links with raw.githack links
- Loading branch information
Showing
1 changed file
with
33 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,25 +26,17 @@ compiler). | |
|
|
||
| ## Install | ||
|
|
||
| ### Local Install | ||
|
|
||
| Install using NPM: | ||
|
|
||
| ```sh | ||
| npm install @lume/kiwi | ||
| ``` | ||
|
|
||
| then import it into your project: | ||
|
|
||
| ```js | ||
| import * as kiwi from '@lume/kiwi' | ||
|
|
||
| console.log(kiwi) | ||
|
|
||
| // ...use kiwi... | ||
| ``` | ||
|
|
||
| If you have a plain web app with no build, or a non-browser JS runtime that also | ||
| supports import maps like Deno, you'll need to add `@lume/kiwi` to your | ||
| `importmap` script so that the browser knows where to import kiwi from. F.e. | ||
| `importmap` script so that the browser or JS runtime knows where to import kiwi from. F.e. | ||
| something like this: | ||
|
|
||
| ```html | ||
|
|
@@ -57,8 +49,32 @@ something like this: | |
| </script> | ||
| ``` | ||
|
|
||
| ### CDN Install | ||
|
|
||
| Note, if using importmaps and native ES Modules in a browser, or in a JS runtime like Deno, you can get Kiwi directly from the UNPKG CDN without installing it locally (just as the [live CodePen demo](#demo) does): | ||
|
|
||
| ```html | ||
| <script type="importmap"> | ||
| { | ||
| "imports": { | ||
| "@lume/kiwi": "https://unpkg.com/@lume/[email protected]/dist/kiwi.js", | ||
| } | ||
| } | ||
| </script> | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| After installing, import kiwi into your project: | ||
|
|
||
| ```js | ||
| import * as kiwi from '@lume/kiwi' | ||
|
|
||
| console.log(kiwi) | ||
|
|
||
| // ...use kiwi... | ||
| ``` | ||
|
|
||
| The following example creates a solver which automatically calculates a width based on some constraints: | ||
|
|
||
| ```js | ||
|
|
@@ -99,7 +115,7 @@ setTimeout(() => { | |
|
|
||
| ## Benchmarks | ||
|
|
||
| To run the benchmark in the browser, [just visit this page](https://rawgit.com/IjzerenHein/kiwi/master/bench/index.html). | ||
| To run the benchmark in the browser, [just visit this page](https://raw.githack.com/lume/kiwi/main/bench/index.html). | ||
|
|
||
| To run the benchmark locally using nodejs, _clone or download this repository_ and execute the following steps: | ||
|
|
||
|
|
@@ -126,7 +142,7 @@ Fastest is kiwi (± 2.29x faster) | |
|
|
||
| ## Tests | ||
|
|
||
| To run the tests in the browser, [just visit this page](https://rawgit.com/IjzerenHein/kiwi/master/test/index.html). | ||
| To run the tests in the browser, [just visit this page](https://raw.githack.com/lume/kiwi/main/test/index.html). | ||
|
|
||
| To run the tests locally using nodejs, _clone or download this repository_ and execute the following steps: | ||
|
|
||
|
|
@@ -150,12 +166,12 @@ open a pull request! | |
|
|
||
| [](<https://tldrlegal.com/license/bsd-3-clause-license-(revised)>) | ||
|
|
||
| <!-- | ||
| TODO | ||
|
|
||
| ## Status | ||
|
|
||
| [](https://travis-ci.org/IjzerenHein/kiwi.js) | ||
| [](https://codecov.io/gh/IjzerenHein/kiwi.js) | ||
| [](https://github.com/lume/kiwi/actions/workflows/tests.yml) | ||
|
|
||
| <!-- | ||
| TODO coverage status | ||
| [](https://codecov.io/gh/IjzerenHein/kiwi.js) | ||
| --> | ||