diff --git a/README.md b/README.md index 5cb0fc2..3d8e2b2 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,49 @@ [![NPM version](https://img.shields.io/npm/v/astro-theme-toggle?color=a1b858&label=)](https://www.npmjs.com/package/astro-theme-toggle) +Create a ripple-style theme toggle animation in your Astro project. + +## Installation + +```bash +npm install astro-theme-toggle +``` + +## Usage + +1. In your `
`, import the `theme-style.astro` component: + + ```astro + --- + import ThemeStyle from 'astro-theme-toggle/theme-style.astro'; + --- + + + + +