diff --git a/README.md b/README.md index 21bd7ac2..33c4b6b6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ # Nitro Renderer +nitro-renderer is a Javascript library for rendering Nitro in the browser using PixiJS + +## Installation + +npm + +``` +npm install @nitrots/nitro-renderer +``` + +yarn + +``` +yarn add @nitrots/nitro-renderer +```