Skip to content

Commit 72b06f7

Browse files
committed
docs: reflect the new repo name, Studio-Web, in the docs
1 parent e05f31f commit 72b06f7

3 files changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# ReadAlongs Web App Suite
22

3-
[![Publish Status](https://github.com/readalongs/Web-Component/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/ReadAlongs/Web-Component/actions)
4-
[![Test Status](https://github.com/readalongs/Web-Component/actions/workflows/end-to-end-tests.yml/badge.svg?branch=main)](https://github.com/ReadAlongs/Web-Component/actions)
5-
[![GitHub license](https://img.shields.io/github/license/ReadAlongs/Web-Component)](https://github.com/ReadAlongs/Web-Component/blob/main/LICENSE)
6-
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/ReadAlongs/Web-Component)
3+
[![Publish Status](https://github.com/readalongs/Studio-Web/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/ReadAlongs/Studio-Web/actions)
4+
[![Test Status](https://github.com/readalongs/Studio-Web/actions/workflows/end-to-end-tests.yml/badge.svg?branch=main)](https://github.com/ReadAlongs/Studio-Web/actions)
5+
[![GitHub license](https://img.shields.io/github/license/ReadAlongs/Studio-Web)](https://github.com/ReadAlongs/Studio-Web/blob/main/LICENSE)
6+
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/ReadAlongs/Studio-Web)
77
[![web-component release](https://img.shields.io/npm/v/@readalongs/web-component)](https://www.npmjs.com/package/@readalongs/web-component)
88
[![ngx-web-component release](https://img.shields.io/npm/v/@readalongs/ngx-web-component)](https://www.npmjs.com/package/@readalongs/ngx-web-component)
99

1010
Interactive story telling embeddable into any website!
1111

1212
<!-- TODO: put an animated GIF here, showing it off! -->
1313

14-
This mono repo combines four packages:
14+
This mono repo, formerly called Web-Component, now called Studio-Web, combines four packages:
1515

1616
- A [stencil web component](packages/web-component/) for visualizing read alongs,
1717
- 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
4646

4747
Clone the repo:
4848

49-
git clone git@github.com:ReadAlongs/Web-Component.git
49+
git clone git@github.com:ReadAlongs/Studio-Web.git
5050

5151
### Installing dependencies
5252

5353
Use `npm` to install all dependencies:
5454

55-
cd Web-Component
55+
cd Studio-Web
5656
npm install
5757

5858
### Serving/Development
@@ -262,7 +262,7 @@ so if you have deployed the API elsewhere, you must:
262262

263263
## Contributing
264264

265-
Feel free to dive in! [Open an issue](https://github.com/ReadAlongs/Web-Component/issues/new) or submit PRs.
265+
Feel free to dive in! [Open an issue](https://github.com/ReadAlongs/Studio-Web/issues/new) or submit PRs.
266266

267267
This repo follows the [Contributor Covenant](https://contributor-covenant.org/version/1/3/0/) Code of Conduct.
268268

docker-notes

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
1313
source /root/.bashrc
1414
nvm install 18.13.0
1515
nvm use 18.13.0
16-
git clone https://github.com/ReadAlongs/Web-Component.git
17-
cd Web-Component
16+
git clone https://github.com/ReadAlongs/Studio-Web.git
17+
cd Studio-Web
1818
npm install
19-
npx nx build web-component
19+
npx nx build web-component

packages/studio-web/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# ReadAlong-Studio Web
22

3-
[![Build Status](https://github.com/readalongs/Web-Component/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/ReadAlongs/Web-Component/actions)
4-
[![GitHub license](https://img.shields.io/github/license/ReadAlongs/Web-Component)](https://github.com/ReadAlongs/Web-Component/blob/main/LICENSE)
5-
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/ReadAlongs/Web-Component/tree/main/packages/studio-web)
3+
[![Build Status](https://github.com/readalongs/Studio-Web/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/ReadAlongs/Studio-Web/actions)
4+
[![GitHub license](https://img.shields.io/github/license/ReadAlongs/Studio-Web)](https://github.com/ReadAlongs/Studio-Web/blob/main/LICENSE)
5+
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/ReadAlongs/Studio-Web/tree/main/packages/studio-web)
66

77
> Web application for audiobook alignment for Indigenous languages!
88
@@ -58,7 +58,7 @@ Run `npm run-script build:prod` to build the project. The build artifacts will b
5858

5959
## Contributing
6060

61-
Feel free to dive in! [Open an issue](https://github.com/ReadAlongs/Web-Component/issues/new) or submit PRs.
61+
Feel free to dive in! [Open an issue](https://github.com/ReadAlongs/Studio-Web/issues/new) or submit PRs.
6262

6363
This repo follows the [Contributor Covenant](https://contributor-covenant.org/version/1/3/0/) Code of Conduct.
6464

0 commit comments

Comments
 (0)