@backan/core - npm Package Compare versions

Comparing version 0.0.18 to 0.0.19

package.json

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

README.md

@@ -28,2 +28,20 @@ # 🔥 Backan - Core
 <!-- PIGEONPOSSE START DOCS -->
+## Table of Contents
+
+  - [🔑 Installation](#-installation)
+    - [Install only `core`](#install-only-core)
+  - [Setup](#setup)
+  - [Create `App` instace](#create-app-instace)
+  - [Create `Route`](#create-route)
+  - [Add `Endpoints`](#add-endpoints)
+  - [What is BACKAN?](#what-is-backan)
+  - [Project intention](#project-intention)
+  - [Contains](#contains)
+  - [Todo](#todo)
+  - [What is `backan` built with?](#what-is-backan-built-with)
+  - [🏁 Get started with `Backan`](#-get-started-with-backan)
+  - [🗄️ Get started with `Backan` server](#-get-started-with-backan-server)
+  - [📦 Build your project](#-build-your-project)
+
+
 Start building your restAPI app now 🌈.
@@ -76,4 +94,4 @@
 
-<video src="https://backan.pigeonposse.com/backan-create.webm" controls/>
 
+
 [Read more](https://backan.pigeonposse.com/guide/create/index)
@@ -94,2 +112,67 @@
 - [STREAM](https://backan.pigeonposse.com/guide/core/stream)
+
+## What is BACKAN?
+
+![HEADER](https://backan.pigeonposse.com/banner.png)
+
+**`BACKAN`** is a library designed to build **REST API** applications quickly and easily.
+
+> [!IMPORTANT]
+> Currently in phase `Beta`
+> The library can be used perfectly in production, but could undergo changes and new features until version `1`.
+> To avoid ongoing maintenance issues, we recommend installing a fixed version (without `^`) in your project.
+
+## Project intention
+
+Our project is not intended to be a substitute for any web framework. Our library aims to cover a specific use case, that of building APIs, simplifying this process as much as possible and creating APIs in a robust way.
+
+The creation of this project is also due to the need of our [collective](htpps://pigeonposse.com) to create APIs with good documentation and in a simple way, an example of this is the Api section of [`bepp`](https://github.com/pigeonposse/bepp/tree/main/packages/api) (a web extension packager).
+
+## Contains
+
+- ✅ Simple `data validation`, so that your endpoints are as secure as possible and reduce repetitive code (boilerplate).
+- ✅ Built-in and almost `automatic OpenAPI documentation`, improving the visibility of our API without the need to import other projects.
+
+In addition, **BACKAN** also provides:
+
+- A backan project creator with templates of greater and lesser complexity. [Read more](https://backan.pigeonposse.com/guide/core/index.md#setup)
+- Configuration to create your [Node server](https://backan.pigeonposse.com/guide/server/index), perfect for running your application without having to configure anything. [Read more](https://backan.pigeonposse.com/guide/server/index)
+- Tool to build the binary of your application, ideal for running the app without the need for a Node.js environment. [Read more](https://backan.pigeonposse.com/guide/builder/index)
+
+> [!note]
+> The documentation is under construction. Soon, we will write all the points it contains
+
+## Todo
+
+- 💡 Typing for make your frontend projects more easy.
+
+[Read more](https://backan.pigeonposse.com/guide/todo/v1)
+
+## What is `backan` built with?
+
+Our library is built under the `hono` framework, which is why you will see references to it in our documentation and our code. **BACKAN** is an implementation that aims to simplify the construction of apirest for specific use cases.
+
+You want to build an apirest quickly and safely and without thinking about third-party implementations, well here we propose our [alternative](https://backan.pigeonposse.com/guide/core/index).
+
+## 🏁 Get started with `Backan`
+
+Start building your restAPI app now 🌈.
+
+[Read more](https://backan.pigeonposse.com/guide/core/index)
+
+## 🗄️ Get started with `Backan` server
+
+[Read more](https://backan.pigeonposse.com/guide/server/index)
+
+## 📦 Build your project
+
+The backan builder library allows you to build multiple things. Among others:
+
+- [**`Executables / binaries`**](https://backan.pigeonposse.com/guide/builder/index.md#build-binaries): Create binaries of your project for all **systems** and **architectures** with zero config. 
+- [**`Client library`**](https://backan.pigeonposse.com/guide/builder/index.md#create-client): Create a client to facilitate the implementation of the API in a frontend or other service. 
+- [**`JSON schema file`**](https://backan.pigeonposse.com/guide/builder/index.md#build-json-types-schema): Export the **OpenAPI schema** to a **JSON file**.
+- [**`TypeScript definitions file`**](https://backan.pigeonposse.com/guide/builder/index.md#build-json-types-schema): Export **OpenAPI schema** to a **d.ts file**.
+- [**`Markdown documentation`**](https://backan.pigeonposse.com/guide/builder/index.md#build-markdown-documentation): Build your application documentation in a **Markdown file**.
+
+[Read more](https://backan.pigeonposse.com/guide/builder/index)
 <!-- PIGEONPOSSE END DOCS -->
@@ -96,0 +179,0 @@

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

81596

increased by5.72%

Number of lines in readme file

276

increased by43.01%

No dependency changes