From 959925eb8f8367070188bc6f5c774e791236677b Mon Sep 17 00:00:00 2001 From: b-ma Date: Tue, 12 Dec 2023 08:20:26 +0100 Subject: [PATCH] docs: review readme --- README.md | 37 ++++++++++++------------------------- 1 file changed, 12 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 1cd4a22c..87b942a8 100644 --- a/README.md +++ b/README.md @@ -9,49 +9,32 @@ Open-source creative coding framework for distributed applications based on Web Primarily focused on music, **soundworks** aims at supporting rapid development of real-time distributed applications using _JavaScript_. It provides abstractions to hide the complexity of the network and to foster very rapid-prototyping and trial-and-error workflows that are typical in artistic practices. -## Getting Started - -The best and most simple way to start using **soundworks** is to use the `@soundworks/create` wizard. - -```sh -npx @soundworks/create@latest -``` - -![./assets/soundworks-create-min.gif](./assets/soundworks-create-min.gif) - -See [https://soundworks.dev/tutorials/getting-started.html](https://soundworks.dev/tutorials/getting-started.html) for more informations on the wizard and how to start with **soundworks**. - - -## API +## Getting started -The API is not publicly published for now. To access the API documentation locally, just clone this repository, go to the v4 branch and launch some http server in the docs directory. For example, using the [serve](https://www.npmjs.com/package/serve) package: +The best and most simple way to start using **soundworks** is to use the `@soundworks/create` wizard. ```sh -git clone https://github.com/collective-soundworks/soundworks.git -cd soundworks -git checkout v4 -serve docs +npx @soundworks/create@latest ``` -Feel welcome to open an [issue](https://github.com/collective-soundworks/soundworks/issues) or a PR if you find any inconsistency, error or missing information in the documentation. +![./assets/soundworks-create-min.gif](./assets/soundworks-create-min.gif) -## Share with Us +See [https://soundworks.dev/tutorials/getting-started.html](https://soundworks.dev/tutorials/getting-started.html) for more informations on the wizard and how to start with **soundworks**. -If you made an application using **soundworks** please let us know here: https://github.com/collective-soundworks/soundworks/discussions/61 +## Misc -## TypeScript Support +### TypeScript support Basic TypeScript support will be proposed in a (hopefully) near future. However, for maintenance reasons, we aim at following the TC39 and W3C specifications as close as possible. Therefore, we will wait for the https://github.com/tc39/proposal-type-annotations proposal to reach stage 3 to update the source code in a more integrated manner. -## Install +### Manual install Note that the `@soundworks/core` package is automatically installed when creating an application using the `@soundworks/create` wizard, so most of the time you should not have to install this package manually. See [https://soundworks.dev/guides/getting-started.html](https://soundworks.dev/guides/getting-started.html) for more informations on the **soundworks** wizard. @@ -59,6 +42,10 @@ Note that the `@soundworks/core` package is automatically installed when creatin npm install @soundworks/core ``` +## Share with Us + +If you made an application using **soundworks** please let us know here: https://github.com/collective-soundworks/soundworks/discussions/61 + ## Credits [https://soundworks.dev/credits.html](https://soundworks.dev/credits.html)