Skip to content

Commit

Permalink
docs: reflect the new repo name, Studio-Web, in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joanise committed Apr 15, 2024
1 parent e05f31f commit 72b06f7
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# ReadAlongs Web App Suite

[![Publish Status](https://github.com/readalongs/Web-Component/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/ReadAlongs/Web-Component/actions)
[![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)
[![GitHub license](https://img.shields.io/github/license/ReadAlongs/Web-Component)](https://github.com/ReadAlongs/Web-Component/blob/main/LICENSE)
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/ReadAlongs/Web-Component)
[![Publish Status](https://github.com/readalongs/Studio-Web/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/ReadAlongs/Studio-Web/actions)
[![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)
[![GitHub license](https://img.shields.io/github/license/ReadAlongs/Studio-Web)](https://github.com/ReadAlongs/Studio-Web/blob/main/LICENSE)
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/ReadAlongs/Studio-Web)
[![web-component release](https://img.shields.io/npm/v/@readalongs/web-component)](https://www.npmjs.com/package/@readalongs/web-component)
[![ngx-web-component release](https://img.shields.io/npm/v/@readalongs/ngx-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,
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions docker-notes
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
source /root/.bashrc
nvm install 18.13.0
nvm use 18.13.0
git clone https://github.com/ReadAlongs/Web-Component.git
cd Web-Component
git clone https://github.com/ReadAlongs/Studio-Web.git
cd Studio-Web
npm install
npx nx build web-component
npx nx build web-component
8 changes: 4 additions & 4 deletions packages/studio-web/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# ReadAlong-Studio Web

[![Build Status](https://github.com/readalongs/Web-Component/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/ReadAlongs/Web-Component/actions)
[![GitHub license](https://img.shields.io/github/license/ReadAlongs/Web-Component)](https://github.com/ReadAlongs/Web-Component/blob/main/LICENSE)
[![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)
[![Build Status](https://github.com/readalongs/Studio-Web/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/ReadAlongs/Studio-Web/actions)
[![GitHub license](https://img.shields.io/github/license/ReadAlongs/Studio-Web)](https://github.com/ReadAlongs/Studio-Web/blob/main/LICENSE)
[![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)

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

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

Expand Down

0 comments on commit 72b06f7

Please sign in to comment.