Skip to content

Commit

Permalink
docs: review readme
Browse files Browse the repository at this point in the history
  • Loading branch information
b-ma committed Dec 12, 2023
1 parent 7dc0f00 commit 959925e
Showing 1 changed file with 12 additions and 25 deletions.
37 changes: 12 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,56 +9,43 @@ 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**.

<!--
## Documentation

- Guides and Tutorials: [https://soundworks.dev](https://soundworks.dev)
- API: [https://soundworks.dev/api](https://soundworks.dev/api)
-->

## 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.

```
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)
Expand Down

0 comments on commit 959925e

Please sign in to comment.