From b8ace74171260acaf47392d737568cec17400b4b Mon Sep 17 00:00:00 2001 From: Bill Thornton Date: Tue, 23 Aug 2022 10:06:54 -0400 Subject: [PATCH] Update README --- README.md | 33 +++++++++++++++++++++------------ 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 231a499c..a5de6450 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,34 @@ -# Website +

jellyfin.org

+

Part of the Jellyfin Project

+ +--- + +

+Logo Banner +

+ +The next generation of the official Jellyfin website. + +This version of the website is currently viewable at [next.jellyfin.org](http://next.jellyfin.org). +The goal of this project is to combine all website on jellyfin.org in a single codebase and improve the documentation site experience. + +This project includes a combination of content from: + +- [jellyfin-blog](https://github.com/jellyfin/jellyfin-blog) — The current source for the main website and blog content built using Hugo. +- [jellyfin-docs](https://github.com/jellyfin/jellyfin-docs) — The current source for the documentation content built using DocFX. This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. ## Installation ```console -yarn install +npm install ``` ## Local Development ```console -yarn start +npm start ``` This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. @@ -19,15 +36,7 @@ This command starts a local development server and opens up a browser window. Mo ## Build ```console -yarn build +npm run build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. - -## Deployment - -```console -GIT_USER= USE_SSH=true yarn 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.