chore: update readme and module name

Author: stafyniaksacha

README.md

@@ -1,4 +1,40 @@
-# Nuxt Module
+# @cssninja/nuxt-media-viewer
+
+A media viewer for public assets in Nuxt.js
+
+## Features
+
+- Preview assets with their meta data
+- Generate snippets for responsive/retina images
+- Generate and customize inline SVG from your assets
+
+
+## Installation
+
+1. Add `@cssninja/nuxt-media-viewer` dependency to your project
+```bash
+# Using pnpm
+pnpm add -D @cssninja/nuxt-media-viewer
+
+# Using yarn
+pnpm add -D @cssninja/nuxt-media-viewer
+
+# Using npm
+npm install --save-dev @cssninja/nuxt-media-viewer
+```
+
+2. Add `@cssninja/nuxt-media-viewer` to the `modules` section of `nuxt.config.js`
+
+```ts
+export default defineNuxtConfig({
+  modules: [
+    '@cssninja/nuxt-media-viewer'
+  ]
+})
+```
+
+3. Go to the media viewer page and start previewing your assets at [http://localhost:3000/_media-viewer](http://localhost:3000/_media-viewer)
+
 
 ## Development
 

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "my-module",
-  "version": "1.0.0",
+  "name": "@cssninja/nuxt-media-viewer",
+  "version": "0.0.1",
   "license": "MIT",
   "type": "module",
   "exports": {

src/module.ts

@@ -6,7 +6,7 @@ import consola from 'consola'
 
 export default defineNuxtModule({
   meta: {
-    name: 'media-viewer'
+    name: '@cssninja/nuxt-media-viewer'
   },
   defaults: {
     installIpxMiddleware: true