@backan/core - npm Package Compare versions

Comparing version 0.0.17 to 0.0.18

package.json

 {
   "name": "@backan/core",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "type": "module",
@@ -5,0 +5,0 @@ "license": "GPL-3.0",

README.md

 # 🔥 Backan - Core
 
 All in one web API builder.
-Create endpoints with type validations and OpenApi documentation, safely and quickly
 
@@ -21,3 +20,3 @@ <!-- PIGEONPOSSE START HEADER -->
 
-Create endpoints with type validations and OpenApi documentation, safely and quickly.
+[**BACKAN**](https://backan.pigeonposse.com/) Create endpoints with type validations and OpenApi documentation, safely and quickly.
 
@@ -29,4 +28,73 @@
 
+<!-- PIGEONPOSSE START DOCS -->
+Start building your restAPI app now 🌈.
+
+## 🔑 Installation
+
+```bash [npm]
+npm install backan
+```
+```bash [pnpm]
+pnpm i backan
+```
+```bash [yarn]
+yarn add backan
+```
+
+[![NPM Version](https://img.shields.io/npm/v/backan?style=for-the-badge&color=yellow)](https://www.npmjs.com/package/backan)
+
+
+### Install only `core`
+
+```bash [npm]
+npm install @backan/core
+```
+```bash [pnpm]
+pnpm i @backan/core
+```
+```bash [yarn]
+yarn add @backan/core
+```
+
+[![NPM Version](https://img.shields.io/npm/v/%40backan%2Fcore?style=for-the-badge&color=yellow)](https://www.npmjs.com/package/@backan/core)
+
+
+## Setup
+
+You can automatically create a `backan` template with:
+
+```bash [npm]
+npm create backan
+```
+```bash [pnpm]
+pnpm create backan
+```
+```bash [yarn]
+yarn create backan
+```
+
+
+<video src="https://backan.pigeonposse.com/backan-create.webm" controls/>
+
+[Read more](https://backan.pigeonposse.com/guide/create/index)
+
+## Create `App` instace
+
+[Read more](https://backan.pigeonposse.com/guide/core/app)
+
+## Create `Route` 
+
+[Read more](https://backan.pigeonposse.com/guide/core/route)
+
+## Add `Endpoints` 
+
+- [GET](https://backan.pigeonposse.com/guide/core/get)
+- [POST](https://backan.pigeonposse.com/guide/core/post)
+- [STREAM](https://backan.pigeonposse.com/guide/core/stream)
+<!-- PIGEONPOSSE END DOCS -->
+
 <!-- PIGEONPOSSE START INDEX -->
 
+## More from Backan
+
 - [Documentation](https://backan.pigeonposse.com/)
@@ -33,0 +101,0 @@ - 📚 [Library](https://backan.pigeonposse.com/guide/core)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

77180

increased by1.73%

Number of lines in readme file

193

increased by54.4%

No dependency changes