@tinyhttp/app - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

package.json

 {
 	"name": "@tinyhttp/app",
-	"version": "0.2.1",
-	"description": "tinyhttp core",
+	"version": "0.2.2",
+	"description": "tinyhttp core with App, Request, Response and Router",
 	"type": "module",
-	"homepage": "https://github.com/talentlessguy/tinyhttp",
+	"homepage": "https://github.com/talentlessguy/tinyhttp#readme",
 	"repository": {
@@ -12,2 +12,5 @@ "type": "git",
 	},
+	"contributors": [
+		"v1rtl <https://v1rtl.site>"
+	],
 	"main": "dist/index.cjs",
@@ -35,3 +38,8 @@ "types": "dist/index.d.ts",
 		"web",
-		"backend"
+		"backend",
+		"http",
+		"http framework",
+		"javascript",
+		"node",
+		"native-esm"
 	],
@@ -38,0 +46,0 @@ "author": "v1rtl",

README.md

@@ -1,9 +0,16 @@
-# tinyhttp
+![](https://tinyhttp.v1rtl.site/cover.jpg)
 
-[![](https://img.shields.io/badge/website-visit-hotpink?style=flat-square)](https://tinyhttp.v1rtl.site) [![Twitter](https://img.shields.io/twitter/follow/v1rtl.svg?label=sub%20to%20twitter&style=flat-square)](twitter.com/v1rtl) [![npm type definitions](https://img.shields.io/npm/types/@tinyhttp/app?style=flat-square)](npmjs.com/@tinyhttp/app)
-![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/body-parsec.svg?style=flat-square)
-![Last commit](https://img.shields.io/github/last-commit/talentlessguy/tinyhttp.svg?style=flat-square) [![NPM](https://img.shields.io/npm/l/@tinyhttp/app?style=flat-square)](npmjs.com/@tinyhttp/app)
+<div align="center">
+<h1>tinyhttp</h1>
 
-> ⚠ The project is in development. Please don't use in production.
+[![](https://img.shields.io/badge/website-visit-hotpink?style=flat-square)](https://tinyhttp.v1rtl.site) [![Twitter](https://img.shields.io/twitter/follow/v1rtl.svg?label=sub%20to%20twitter&style=flat-square)](twitter.com/v1rtl) [![npm](https://img.shields.io/npm/dt/@tinyhttp/app?style=flat-square)](https://npm.im/@tinyhttp/app) [![npm type definitions](https://img.shields.io/npm/types/@tinyhttp/app?style=flat-square)](npmjs.com/@tinyhttp/app) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/talentlessguy/tinyhttp/CI?style=flat-square)
+![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/body-parsec.svg?style=flat-square) ![Codacy grade](https://img.shields.io/codacy/grade/239a8cc7bca24042940f018a1ccec72f?style=flat-square) ![David (path)](https://img.shields.io/david/talentlessguy/tinyhttp?path=packages%2Fapp&style=flat-square)
+![Last commit](https://img.shields.io/github/last-commit/talentlessguy/tinyhttp.svg?style=flat-square) [![NPM](https://img.shields.io/npm/l/@tinyhttp/app?style=flat-square)](npmjs.com/@tinyhttp/app) [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
 
+<p>⚡ Tiny web framework as a replacement of Express</p>
+
+</div>
+
+**⚠ The project is in development. Please don't use in production.**
+
 _**tinyhttp**_ is a modern Express-like web framework for Node.js. It uses a bare minimum amount of dependencies trying to avoid legacy hell.
@@ -15,6 +22,6 @@
 - ↪ Async middleware support
+- ☑ Native ESM and CommonJS support
+- 🚀 No legacy dependencies, just the JavaScript itself
+- 🔨 Types out of the box
 - 📦 8x smaller than Express
-- 🏃 No legacy dependencies
-- 🔨 Types out of the box
-- ☑ Native ESM and CommonJS support
 
@@ -25,3 +32,3 @@ To get started, visit [tinyhttp website](https://tinyhttp.v1rtl.site).
 
-[Node.js 12.4.0 or newer](https://node.green/#ES2019) is required.
+tinyhttp requires [Node.js 12.4.0 or newer](https://node.green/#ES2019). It is recommended to use [pnpm](https://pnpm.js.org/), although it isn't required.
 
@@ -41,4 +48,6 @@ ```sh
 
-## Example
+## Get Started
 
+The app structure is quite similar to Express, except that you need to import `App` from `@tinyhttp/app` instead of default import from `express`.
+
 ```ts
@@ -65,3 +74,3 @@ import { App } from '@tinyhttp/app'
 
-For more examples check [examples](https://github.com/talentlessguy/tinyhttp/blob/master/examples) folder.
+For more examples, check [examples](https://github.com/talentlessguy/tinyhttp/blob/master/examples) folder.
 
@@ -74,4 +83,28 @@ ## Middlewares
 
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
 ## License
 
 MIT © [v1rtl](https://v1rtl.site)
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://brailor.me/"><img src="https://avatars3.githubusercontent.com/u/17928339?v=4" width="100px;" alt=""/><br /><sub><b>Matt</b></sub></a><br /><a href="#plugin-BRA1L0R" title="Plugin/utility libraries">🔌</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

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

49453

increased by4.16%

Number of lines in readme file

106

increased by45.21%

No dependency changes