backan - npm Package Compare versions

Comparing version 0.0.17 to 0.0.18

package.json

 {
   "name": "backan",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "type": "module",
@@ -35,3 +35,3 @@ "license": "GPL-3.0",
   "dependencies": {
-    "@backan/core": "0.0.17"
+    "@backan/core": "0.0.18"
   },
@@ -38,0 +38,0 @@ "scripts": {

README.md

 # 🔥 Backan 
 
 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.
 
@@ -27,4 +26,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/)
@@ -31,0 +99,0 @@ - 📚 [Library](https://backan.pigeonposse.com/guide/core)

No alert changes

Improved metrics

Total package byte prevSize

76748

increased by1.74%

Number of lines in readme file

191

increased by55.28%

Dependency changes

• + Added@backan/core@0.0.18(transitive)

• - Removed@backan/core@0.0.17(transitive)

• Updated@backan/core@0.0.18