Skip to content

Commit b0e47ed

Browse files
committed
docs: Add usage documentation to the readme
1 parent 3d8f95f commit b0e47ed

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,34 @@ Renda comes with an online editor called [Renda Studio](https://renda.studio)
1313
where you can easily build your scenes and adjust parameters to your liking.
1414

1515
For more information, visit [rendajs.org](https://rendajs.org/).
16+
17+
## Usage
18+
19+
It is recommended to start out with the editor over at https://renda.studio.
20+
Check out the
21+
[getting started guide](https://rendajs.org/manual/getting-started) for more
22+
info.
23+
24+
But if you prefer to use Renda as a library, without using Renda Studio, you can
25+
import it using the jsDelivr cdn:
26+
27+
```js
28+
<script type="module">
29+
import {Vec3} from "https://cdn.jsdelivr.net/npm/renda@latest/dist/renda.js";
30+
31+
console.log(new Vec3(1,2,3).magnitude);
32+
</script>;
33+
```
34+
35+
Or if you have a build step, you can also use the official
36+
[npm package](https://npmjs.com/package/renda):
37+
38+
```
39+
npm i renda
40+
```
41+
42+
And finally, Renda is also available on
43+
[deno.land/x](https://deno.land/x/renda).
44+
45+
If you wish to use Renda as library, you can find a
46+
[getting started guide here](https://www.npmjs.com/package/renda).

0 commit comments

Comments
 (0)