-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: reflect the new repo name, Studio-Web, in the docs
- Loading branch information
Showing
3 changed files
with
15 additions
and
15 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 |
---|---|---|
@@ -1,17 +1,17 @@ | ||
# ReadAlongs Web App Suite | ||
|
||
[](https://github.com/ReadAlongs/Web-Component/actions) | ||
[](https://github.com/ReadAlongs/Web-Component/actions) | ||
[](https://github.com/ReadAlongs/Web-Component/blob/main/LICENSE) | ||
[](https://github.com/ReadAlongs/Web-Component) | ||
[](https://github.com/ReadAlongs/Studio-Web/actions) | ||
[](https://github.com/ReadAlongs/Studio-Web/actions) | ||
[](https://github.com/ReadAlongs/Studio-Web/blob/main/LICENSE) | ||
[](https://github.com/ReadAlongs/Studio-Web) | ||
[](https://www.npmjs.com/package/@readalongs/web-component) | ||
[](https://www.npmjs.com/package/@readalongs/ngx-web-component) | ||
|
||
Interactive story telling embeddable into any website! | ||
|
||
<!-- TODO: put an animated GIF here, showing it off! --> | ||
|
||
This mono repo combines four packages: | ||
This mono repo, formerly called Web-Component, now called Studio-Web, combines four packages: | ||
|
||
- A [stencil web component](packages/web-component/) for visualizing read alongs, | ||
- An [Angular Library](packages/ngx-web-component/) that wraps the stencil web component, | ||
|
@@ -46,13 +46,13 @@ repository. You also should only run commands from the root of the repo. See gui | |
|
||
Clone the repo: | ||
|
||
git clone [email protected]:ReadAlongs/Web-Component.git | ||
git clone [email protected]:ReadAlongs/Studio-Web.git | ||
|
||
### Installing dependencies | ||
|
||
Use `npm` to install all dependencies: | ||
|
||
cd Web-Component | ||
cd Studio-Web | ||
npm install | ||
|
||
### Serving/Development | ||
|
@@ -262,7 +262,7 @@ so if you have deployed the API elsewhere, you must: | |
|
||
## Contributing | ||
|
||
Feel free to dive in! [Open an issue](https://github.com/ReadAlongs/Web-Component/issues/new) or submit PRs. | ||
Feel free to dive in! [Open an issue](https://github.com/ReadAlongs/Studio-Web/issues/new) or submit PRs. | ||
|
||
This repo follows the [Contributor Covenant](https://contributor-covenant.org/version/1/3/0/) Code of Conduct. | ||
|
||
|
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
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