@devbro/pashmak 0.1.52 → 0.1.53

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +31 -5
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,11 +1,37 @@
1
1
  # @devbro/pashmak
2
2
 
3
- framework for boring developers.
3
+ > [!CAUTION]
4
+ > Still in Beta. Stable to use but not fully battle tested. I expect a few more things to change. For the most part only new stuff will be added so backward compatibility is mostly guaranteed.
4
5
 
5
- ## how to use
6
+ Inspired by laravel and Rails, Pashmak is a typescript focused, ESM first framework. Pashmak was created to provide a simple and seamless way to build web applications, APIs, and services using modern JavaScript and TypeScript features. It is ideal for rapid prototyping and development of web applications, RESTful APIs, and microservices.
6
7
 
7
- -- TODO: more details coming soon, or check test-app under repo for basic setup
8
+ Pashmak is designed with developer experience, rapid development and delivery in mind. It aims to provide a clean and intuitive approach so developers can focus on writing business logic rather than dealing with boilerplate code.
8
9
 
9
- ## official docs
10
+ for documentation please check [documentations](https://devbro1.github.io/pashmak/)
10
11
 
11
- https://devbro1.github.io/pashmak/
12
+ ## Neko Packages
13
+
14
+ Pashmak framework is built from several independent packages that you can use freely:
15
+
16
+ - [neko-cache](https://www.npmjs.com/package/@devbro/neko-cache): Caching providers
17
+ - [neko-config](https://www.npmjs.com/package/@devbro/neko-config): Configuration management
18
+ - [neko-context](https://www.npmjs.com/package/@devbro/neko-context): Context management
19
+ - [neko-helper](https://www.npmjs.com/package/@devbro/neko-helper): Helper utilities
20
+ - [neko-http](https://www.npmjs.com/package/@devbro/neko-http): HTTP client
21
+ - [neko-logger](https://www.npmjs.com/package/@devbro/neko-logger): Logging utilities
22
+ - [neko-mailer](https://www.npmjs.com/package/@devbro/neko-mailer): Email handling
23
+ - [neko-orm](https://www.npmjs.com/package/@devbro/neko-orm): Object-relational mapping
24
+ - [neko-queue](https://www.npmjs.com/package/@devbro/neko-queue): Queue management
25
+ - [neko-router](https://www.npmjs.com/package/@devbro/neko-router): Routing utilities
26
+ - [neko-scheduler](https://www.npmjs.com/package/@devbro/neko-scheduler): Task scheduling
27
+ - [neko-sql](https://www.npmjs.com/package/@devbro/neko-sql): SQL query builder
28
+ - [neko-storage](https://www.npmjs.com/package/@devbro/neko-storage): Storage providers
29
+
30
+ ## Quick start
31
+
32
+ ### Installation
33
+
34
+ ```bash
35
+ npm install -g @devbro/pashmak
36
+ pashmak create project --path . --git
37
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devbro/pashmak",
3
- "version": "0.1.52",
3
+ "version": "0.1.53",
4
4
  "description": "testing application for the entire repo",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",