Skip to content

Commit

Permalink
chore: Readme & pakage keywords
Browse files Browse the repository at this point in the history
  • Loading branch information
aminmokhtari94 committed Oct 30, 2023
1 parent abf824d commit 2624f3a
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 13 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ NuxtJs RTLCSS Module to build Cascading Style Sheets (CSS) with Left-To-Right (L
## Features

- Auto RTL All Styles
- 🚠  Bar
- 🌲  Baz
- Nuxt 3

## Quick Setup

Expand All @@ -37,40 +36,40 @@ npm install --save-dev nuxt-rtlcss
```js
export default defineNuxtConfig({
modules: [
// @nuxtjs/tailwindcss or any styled base module
// "@nuxtjs/tailwindcss" or any styled base module
"nuxt-rtlcss",
],
});
```

> ⚠️ make sure load `nuxt-rtlcss` module end of `modules` list.
> ⚠️ make sure load `nuxt-rtlcss` module at the end of `modules` list.
That's it! You can now use My Module in your Nuxt app ✨

## Development

```bash
# Install dependencies
npm install
pnpm install

# Generate type stubs
npm run dev:prepare
pnpm run dev:prepare

# Develop with the playground
npm run dev
pnpm run dev

# Build the playground
npm run dev:build
pnpm run dev:build

# Run ESLint
npm run lint
pnpm run lint

# Run Vitest
npm run test
npm run test:watch
pnpm run test
pnpm run test:watch

# Release new version
npm run release
pnpm run release
```

<!-- Badges -->
Expand Down
15 changes: 14 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@
"description": "PostCSS RTLCSS Nuxt module",
"repository": "aminmokhtari94/nuxt-rtlcss",
"license": "MIT",
"keywords": [
"nuxt",
"nuxtjs",
"nuxt-module",
"css",
"rtl",
"ltr",
"right-to-left",
"left-to-right",
"postcss-rtlcss",
"postcss",
"rtlcss"
],
"type": "module",
"exports": {
".": {
Expand Down Expand Up @@ -43,4 +56,4 @@
"nuxt": "^3.8.0",
"vitest": "^0.33.0"
}
}
}

0 comments on commit 2624f3a

Please sign in to comment.