Merge pull request #83 from jtpio/update-readme

Point to the JupyterLite documentation in the README

Author: jtpio

README.md

@@ -17,70 +17,13 @@ JupyterLite is being tested against modern web browsers:
 - Firefox 90+
 - Chromium 89+
 
-## Usage
+## Deploy your JupyterLite website on GitHub Pages
 
-This repository provides a demonstration of how to:
+Check out the guide on the JupyterLite documentation: https://jupyterlite.readthedocs.io/en/latest/quickstart/deploy.html
 
-- build a JupyterLite release using prebuilt JupyterLite assets that bundles a collection of pre-existing Jupyter notebooks as part of the distribution;
-- deploy the release to GitHub Pages.
-
-The process is automated using Github Actions.
-
-You can use this repository in two main ways:
-
-- generate a new repository from this template repository and build and deploy your own site to the corresponding Github Pages site;
-- build a release from a PR made to this repository and download the release from the created GitHub Actions artifact.
-
-### Using Your Own Repository to Build a Release and Deploy it to Github Pages
-
-*Requires Github account.*
-
-Click on "Use this template" to generate a repository of your own from this template:
-
-![template](https://user-images.githubusercontent.com/21197331/125816904-5768008a-77de-4cb3-8013-f3999b135c02.gif)
-
-From the [*Actions*](./actions) tab on your repository, ensure that workflows are enabled. When you make a commit to the `main` branch, a Github Action will run to build your JupoyterLite release and deploy it to the repository's Github Pages site. By default, the Github Pages site will be found at `YOUR_GITHUB_USERNAME.github.io/YOUR_REPOSITORY-NAME`. *You can also check the URL from the Repository `Settings` tab `Pages` menu item.*
-
-If the deployment failed, go to "Settings - Actions - General", in the "Workflow permissions" section, check "Read and write permissions". Update files such as readme, and commit so that GitHub rebuids and re-deploys the project. Go to "Settings - Pages", choose "gh-pages" as the source.
-
-
-__Add any additional requirements as required to the `requirements.txt` file.__
-
-*You can do this via the Github website by selecting the `requirements.txt` file, clicking to edit it, making the required changes then saving ("committing") the result to the `main` branch of your repository.*
-
-__Modify the contents of the `contents` folder to include the notebooks you want to distribute as part of your distribution.__
-
-*You can do this by clicking on the `contents` directory and dragging notebooks from your desktop onto the contents listing. Wait for the files to be uploaded and then save them ("commit" them) to the `main` branch of the repository.*
-
-Check that you have Github Pages enabled for your repository: from your repository [*Settings*](./settings) tab, select the [*Pages*](./settings/pages) menu item and ensure that the source is set to `gh-pages`.
-
-When you commit a file, an updated release will be built and published on the Github Pages site. Note that it may take a few minutes for the Github Pages site to be updated. Do a hard refresh on your Github Pages site in your web browser to see the new release.
-
-
-
-### Further Information and Updates
+## Further Information and Updates
 
 For more info, keep an eye on the JupyterLite documentation:
 
-- Configuring: https://jupyterlite.readthedocs.io/en/latest/configuring.html
-- Deploying: https://jupyterlite.readthedocs.io/en/latest/deploying.html
-
-### Deploy a new version of JupyterLite
-
-To change the version of the prebuilt JupyterLite assets, update the `jupyterlite` package version in the [requirements.txt](./blob/main/requirements.txt) file.
-
-The `requirements.txt` file can also be used to add extra prebuilt ("federated") JupyterLab extensions to the deployed JupyterLite website.
-
-Commit and push any changes. The site will be deployed on the next push to the `main` branch.
-
-## Development
-
-Create a new environment:
-
-```bash
-mamba create -n jupyterlite-demo
-conda activate jupyterlite-demo
-pip install -r requirements.txt
-```
-
-Then follow the steps documented in the [Configuring](https://jupyterlite.readthedocs.io/en/latest/configuring.html) section.
+- How-to Guides: https://jupyterlite.readthedocs.io/en/latest/howto/index.html
+- Reference: https://jupyterlite.readthedocs.io/en/latest/reference/index.html