update README

keita-hino · Aug 22, 2023 · 931cfec · 931cfec
1 parent 7399ef5
commit 931cfec
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/.changeset/wild-windows-suffer.md b/.changeset/wild-windows-suffer.md
@@ -0,0 +1,5 @@
+---
+'vite-plugin-sri2': patch
+---
+
+update document
diff --git a/README.md b/README.md
@@ -1,6 +1,9 @@
 # vite-plugin-sri2
 
-This is a Vite plugin for adding [Subresource Integrity](https://developer.mozilla.org/ja/docs/Web/Security/Subresource_Integrity).
+Vite Plugin SRI2 adds [Subresource Integrity (SRI)](https://developer.mozilla.org/ja/docs/Web/Security/Subresource_Integrity) to the `<script>` and `<link>` elements in your "index.html" file during at build time.
+
+Below are examples of how the `<script>` and `<link>` elements in your built "index.html" file would look like after SRI attributes have been added:  
+<img width="1039" alt="スクリーンショット 2023-08-22 8 58 51" src="https://github.com/keita-hino/vue-tsc-action/assets/15973671/d32422ed-a248-440b-a320-99e253909a3e">
 
 ## Installation
 

diff --git a/packages/vite-plugin-sri2/README.md b/packages/vite-plugin-sri2/README.md
@@ -1,6 +1,9 @@
 # vite-plugin-sri2
 
-This is a Vite plugin for adding [Subresource Integrity](https://developer.mozilla.org/ja/docs/Web/Security/Subresource_Integrity).
+Vite Plugin SRI2 adds [Subresource Integrity (SRI)](https://developer.mozilla.org/ja/docs/Web/Security/Subresource_Integrity) to the `<script>` and `<link>` elements in your "index.html" file during at build time.
+
+Below are examples of how the `<script>` and `<link>` elements in your built "index.html" file would look like after SRI attributes have been added:  
+<img width="1039" alt="スクリーンショット 2023-08-22 8 58 51" src="https://github.com/keita-hino/vue-tsc-action/assets/15973671/d32422ed-a248-440b-a320-99e253909a3e">
 
 ## Installation