Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sleeyax committed Aug 18, 2024
1 parent 257d8e8 commit b7fc3cf
Showing 1 changed file with 8 additions and 15 deletions.
23 changes: 8 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Website
# Stremio Guide

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
> [!NOTE]
> This project is a work in progress. Join our [community Discord server](https://discord.gg/zNRf6YF) if you would like to contribute early on.
An unofficial and community-maintained guide to Stremio.

This project is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

Expand All @@ -26,16 +31,4 @@ This command generates static content into the `build` directory and can be serv

### Deployment

Using SSH:

```
$ USE_SSH=true npm run deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> npm run deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Create a PR to the `main` branch. Once the PR has been reviewed and merged by our core collaborators, the changes will be automatically deployed to GitHub Pages.

0 comments on commit b7fc3cf

Please sign in to comment.