chore: update docs

unplugin · Nov 30, 2023 · f8ce71e · f8ce71e
1 parent 1f71bac
commit f8ce71e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 [![Unit Test](https://github.com/sxzz/unplugin-raw/actions/workflows/unit-test.yml/badge.svg)](https://github.com/sxzz/unplugin-raw/actions/workflows/unit-test.yml)
 
+Transform file to a default-export string. It will be transformed to JavaScript, then a string.
+
 ## Installation
 
 ```bash
@@ -63,6 +65,14 @@ module.exports = {
 
 <br></details> -->
 
+## Usage
+
+```ts
+import text from './ts.ts?raw'
+import text2 from './js.js?raw'
+import text3 from './jsx.jsx?raw'
+```
+
 ## Sponsors
 
 <p align="center">

diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "unplugin-raw",
   "version": "0.0.0",
   "packageManager": "pnpm@8.11.0",
-  "description": "Import raw content",
+  "description": "Transform file to a default-export string.",
   "keywords": [
     "unplugin",
     "rollup",