Move to Renderer V2

README.md

@@ -1,50 +1,17 @@
-# Nitro React v2.1
+# Nitro Renderer
 
-## Prerequisites
-
--   [Git](https://git-scm.com/)
--   [NodeJS](https://nodejs.org/) >= 18
-    - If using NodeJS < 18 remove `--openssl-legacy-provider` from the package.json scripts
--   [Yarn](https://yarnpkg.com/) `npm i yarn -g`
+nitro-renderer is a Javascript library for rendering Nitro in the browser using PixiJS
 
 ## Installation
 
--   First you should open terminal and navigate to the folder where you want to clone Nitro
--   Clone Nitro
-    -   `git clone https://git.krews.org/nitro/nitro-react.git`
--   Install the dependencies
-    -   `yarn install`
-    -   This may take some time, please be patient
--   Rename a few files
-    -   Rename `public/renderer-config.json.example` to `public/renderer-config.json`
-    -   Rename `public/ui-config.json.example` to `public/ui-config.json`
--   Set your links
-    -   Open `public/renderer-config.json`
-        -   Update `socket.url, asset.url, image.library.url, & hof.furni.url`
-    -   Open `public/ui-config.json`
-        -   Update `camera.url, thumbnails.url, url.prefix, habbopages.url`
-    -   You can override any variable by passing it to `NitroConfig` in the index.html
-
-## Usage
-
--   To use Nitro you need `.nitro` assets generated, see [nitro-converter](https://git.krews.org/nitro/nitro-converter) for instructions
--   See [Morningstar Websockets](https://git.krews.org/nitro/ms-websockets) for instructions on configuring websockets on your server
-
-### Development
-
-Run Nitro in development mode when you are editing the files, this way you can see the changes in your browser instantly
+npm
 
 ```
-yarn start
+npm install @nitrots/nitro-renderer
 ```
 
-### Production
-
-To build a production version of Nitro just run the following command
+yarn
 
 ```
-yarn build:prod
+yarn add @nitrots/nitro-renderer
 ```
-
--   A `dist` folder will be generated, these are the files that must be uploaded to your webserver
--   Consult your CMS documentation for compatibility with Nitro and how to add the production files