chore: Update READMEs

Signed-off-by: Chawye Hsu <[email protected]>
chawyehsu · Jan 18, 2025 · 60cf337 · 60cf337
1 parent c49f1fb
commit 60cf337
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 18 deletions.
diff --git a/packages/@alterjs/saber-plugin-image/README.md b/packages/@alterjs/saber-plugin-image/README.md
@@ -1,11 +1,11 @@
-# saber-plugin-image
+# @alterjs/saber-plugin-image
 
 Allows the generation of responsive images (`srcset` included), lazy-loading and all that good stuff.
 
 ## Install
 
 ```bash
-yarn add saber-plugin-image
+yarn add @alterjs/saber-plugin-image
 ```
 
 ## Usage
@@ -14,7 +14,7 @@ In your `saber-config.yml`:
 
 ```yml
 plugins:
-  - resolve: saber-plugin-image
+  - resolve: '@alterjs/saber-plugin-image'
     options:
       sizes:
         - 1000

diff --git a/packages/@alterjs/saber-plugin-meta-redirect/README.md b/packages/@alterjs/saber-plugin-meta-redirect/README.md
@@ -1,11 +1,11 @@
-# saber-plugin-meta-redirect
+# @alterjs/saber-plugin-meta-redirect
 
 Generates `<meta>` redirect html files for redirecting on any static file host.
 
 ## Install
 
 ```bash
-yarn add saber-plugin-meta-redirect
+yarn add @alterjs/saber-plugin-meta-redirect
 ```
 
 ## Usage
@@ -14,7 +14,7 @@ In your `saber-config.yml`:
 
 ```yml
 plugins:
-  - resolve: saber-plugin-meta-redirect
+  - resolve: '@alterjs/saber-plugin-meta-redirect'
 ```
 
 In your `saber-node.js`:

diff --git a/packages/@alterjs/saber-plugin-netlify-redirect/README.md b/packages/@alterjs/saber-plugin-netlify-redirect/README.md
@@ -1,11 +1,11 @@
-# saber-plugin-netlify-redirect
+# @alterjs/saber-plugin-netlify-redirect
 
 Automatically generate or update `_redirects` file in your public folder for [Netlify](https://www.netlify.com/docs/redirects/).
 
 ## Install
 
 ```bash
-yarn add saber-plugin-netlify-redirect
+yarn add @alterjs/saber-plugin-netlify-redirect
 ```
 
 ## Usage
@@ -14,7 +14,7 @@ In your `saber-config.yml`:
 
 ```yml
 plugins:
-  - resolve: saber-plugin-netlify-redirect
+  - resolve: '@alterjs/saber-plugin-netlify-redirect'
 ```
 
 Then you can create redirects using the [`pages.createRedirect`](<https://saber.land/docs/saber-instance.html#pages.createredirect(config)>) API.

diff --git a/packages/@alterjs/saber-plugin-pwa/README.md b/packages/@alterjs/saber-plugin-pwa/README.md
@@ -1,11 +1,11 @@
-# saber-plugin-pwa
+# @alterjs/saber-plugin-pwa
 
 Add PWA (progressive web app) support to your Saber app.
 
 ## Install
 
 ```bash
-yarn add saber-plugin-pwa
+yarn add @alterjs/saber-plugin-pwa
 ```
 
 ## Usage
@@ -14,7 +14,7 @@ In your `saber-config.yml`:
 
 ```yml
 plugins:
-  - resolve: saber-plugin-pwa
+  - resolve: '@alterjs/saber-plugin-pwa'
 ```
 
 Then you need to create a set of icons in `static` folder to make your app installable, for example:

diff --git a/packages/@alterjs/saber-plugin-search/README.md b/packages/@alterjs/saber-plugin-search/README.md
@@ -1,11 +1,11 @@
-# saber-plugin-search
+# @alterjs/saber-plugin-search
 
 Adds a hyper-fast, easy to integrate and highly customizable search to your app.
 
 ## Install
 
 ```bash
-yarn add saber-plugin-search
+yarn add @alterjs/saber-plugin-search
 ```
 
 ## Usage
@@ -14,7 +14,7 @@ In your `saber-config.yml`:
 
 ```yml
 plugins:
-  - resolve: saber-plugin-search
+  - resolve: '@alterjs/saber-plugin-search'
 ```
 
 Then in your Vue components, you can call `this.$fetchSearchDatabase()` to get the database that you can query from, this method returns a Promise which resolves an array of `Page` objects:

diff --git a/packages/@alterjs/saber-plugin-transformer-pug/README.md b/packages/@alterjs/saber-plugin-transformer-pug/README.md
@@ -1,11 +1,11 @@
-# saber-plugin-transformer-pug
+# @alterjs/saber-plugin-transformer-pug
 
 Write pages in Pug and add support for importing Pug files
 
 ## Install
 
 ```bash
-yarn add saber-plugin-transformer-pug
+yarn add @alterjs/saber-plugin-transformer-pug
 ```
 
 ## Usage
@@ -14,7 +14,7 @@ In your `saber-config.yml`:
 
 ```yml
 plugins:
-  - resolve: saber-plugin-transformer-pug
+  - resolve: '@alterjs/saber-plugin-transformer-pug'
 ```
 
 Try it by populating a `pages/try.pug`:

diff --git a/packages/create-saber/README.md b/packages/create-saber/README.md
@@ -0,0 +1 @@
+../@alterjs/saber/README.md