Skip to content

Commit

Permalink
docs: add info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Barbapapazes committed Jun 12, 2024
1 parent ef66be4 commit 3077657
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 9 deletions.
1 change: 0 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@


## v0.0.1

27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,18 @@ Find and replace all on all files (CMD+SHIFT+F):
- Description: My new Nuxt module
-->

# My Module
# Nuxt Authorization

Handle authorization with ease in both Nuxt and Nitro.

> [!NOTE]
> In the future, this module could be available as a Nitro module and a Nuxt module.
<!--
- define ability
- ability return an authorization response => boolean or custom object
- bouncer execute the ability to allow, deny or authorize the request -->


[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
Expand Down Expand Up @@ -42,27 +53,27 @@ That's it! You can now use My Module in your Nuxt app ✨

<details>
<summary>Local development</summary>

```bash
# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release
```
Expand Down

0 comments on commit 3077657

Please sign in to comment.