Skip to content

Commit

Permalink
One more readme nudge
Browse files Browse the repository at this point in the history
  • Loading branch information
nick-thompson committed May 9, 2023
1 parent 26d453a commit 13f63db
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
<img height="120px" src="https://www.elementary.audio/Lockup.svg" alt="Elementary Audio logo" />
<br /><br />

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/elemaudio/elementary/blob/main/LICENSE.md)
[![CI Status](https://github.com/elemaudio/elementary/actions/workflows/main.yml/badge.svg)](https://github.com/elemaudio/elementary/actions)
![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/elemaudio/elementary/blob/main/LICENSE.md)
[![Discord Community](https://img.shields.io/discord/826071713426178078?label=Discord)](https://discord.gg/xSu9JjHwYc)

</div>

Expand All @@ -18,11 +19,14 @@

## Getting Started

Elementary is designed to be used in a number of different environments, which makes for several different ways to get started. If you're new to the project, we recommend
starting with one of the following workflows to get the feel of working in Elementary:
Every Elementary application starts with the [@elemaudio/core](https://www.elementary.audio/docs/packages/core) package ([npm](https://www.npmjs.com/package/@elemaudio/core), [source](./js/packages/core)), which provides the
framework for defining your audio processes and a generic set of utilities for performing the graph rendering and reconciling steps.

Next, because Elementary is designed to be used in a number of different environments, there are several different ways to integrate.
If you're new to the project, we recommend starting with one of the following workflows to get the feel of working in Elementary:

* Use the [web-renderer](https://www.elementary.audio/docs/packages/web-renderer) with your favorite frontend UI library to make an audio web application
* Use the [offline-renderer](https://www.elementary.audio/docs/packages/offline-renderer) with Node.js for static file processing
* Use the [@elemaudio/web-renderer](https://www.elementary.audio/docs/packages/web-renderer) package ([npm](https://www.npmjs.com/package/@elemaudio/web-renderer), [source](./js/packages/web-renderer)) with your favorite frontend UI library to make an audio web application
* Use the [@elemaudio/offline-renderer](https://www.elementary.audio/docs/packages/offline-renderer) package ([npm](https://www.npmjs.com/package/@elemaudio/offline-renderer), [source](./js/packages/offline-renderer)) with Node.js for static file processing

Once you're comfortable with the basics, you can dive deeper into integrating and extending Elementary with your existing stack:

Expand Down
2 changes: 1 addition & 1 deletion js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ done locally and publishing automatically from CI via Github Actions.
To mark a new version:

```bash
npx lerna version --no-push
npx lerna version -m 'Publish v2.0.0' --no-push
```

Finally, from Github Actions we have a publish action which runs lerna's `from-package` feature
Expand Down

0 comments on commit 13f63db

Please sign in to comment.