Skip to content

Commit b4bb7e8

Browse files
committed
Update README
Remove unused gh-pages
1 parent b358580 commit b4bb7e8

3 files changed

Lines changed: 20 additions & 566 deletions

File tree

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,20 @@
88
* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
99
* A [GitHub](https://github.com/signup) account :octocat:
1010

11+
## Pages
12+
13+
### `<Home />`
14+
15+
The default page that uses an OptionsMenu for navigating to About, Settings, or Privacy (external).
16+
17+
### `<About />`
18+
19+
A simple page displaying a static description.
20+
21+
### `<Settings />`
22+
23+
A page for configuring the application. By default, the application will detect the best candidate from the browser's language. Users can override this on the settings page.
24+
1125
## Components
1226

1327
### `<Header />`
@@ -34,7 +48,11 @@ Because developers cannot override the RSK behavior, clicking RSK also calls `hi
3448

3549
## Deploy to GitHub Pages
3650

37-
[GitHub Pages](https://pages.github.com/) offers free hosting for public open-source repositories.
51+
[https://cloudmosa.github.io/cloudphone-react-sample/](https://cloudmosa.github.io/cloudphone-react-sample/)
52+
53+
[GitHub Pages](https://pages.github.com/) offers free hosting for public open-source repositories. This project uses the [JamesIves/github-pages-deploy-action](https://github.com/JamesIves/github-pages-deploy-action) GitHub Action to build and deploy HTML, CSS, and JS to the `gh-pages` branch.
54+
55+
:warning <u>Production</u>: although it's possible to configure [custom domain names](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages), "GitHub Pages is not intended for or allowed to be used... either facilitating commercial transactions or providing commercial software" ([see Prohibited Uses](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#prohibited-uses)). Use GitHub Pages for production applications at your own risk.
3856

3957
## License
4058

0 commit comments

Comments
 (0)