@coloneldev/framework 0.1.0 → 0.1.1
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.
- package/README.md +38 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# @coloneldev/framework
|
|
2
|
+
|
|
3
|
+
Core HTTP and routing runtime for Colonel applications.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
bun add @coloneldev/framework
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
or
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @coloneldev/framework
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Exports
|
|
18
|
+
|
|
19
|
+
The package currently exports framework primitives from the root entry:
|
|
20
|
+
|
|
21
|
+
- `Kernel`
|
|
22
|
+
- `Router`
|
|
23
|
+
- `HttpRequest`
|
|
24
|
+
- `redirect`
|
|
25
|
+
- static file helpers (`isStaticPath`, `toPublicFilePath`, `contentTypeFor`)
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import { Kernel, Router } from "@coloneldev/framework";
|
|
31
|
+
|
|
32
|
+
const router = new Router();
|
|
33
|
+
const kernel = new Kernel(router);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## License
|
|
37
|
+
|
|
38
|
+
MIT
|