fixing README

Author: softchris

README.md

@@ -6,9 +6,8 @@
 ## Table of Contents
 
 - [About](#about)
-- [Features](#features)
 - [Install](#install)
-- [Run](#run)
+- [Features](#features)
 - [Create an app](#create-an-app)
 
 ## About
@@ -17,6 +16,12 @@ This is a minimalistic Web framework for Node.js. It helps you create RESTful AP
 
 The idea is to have 0 dependencies while still have all the functionality you would expect from bigger frameworks like Express, Koa, Fastify etc with just a fraction of the footprint.
 
+## Install
+
+```bash
+npm install quarkhttp
+```
+
 ## Features
 
 - Create routes supporting GET, POST, PUT, DELETE HTTP Verbs. There are convenience methods for this:
@@ -49,30 +54,23 @@ The idea is to have 0 dependencies while still have all the functionality you wo
    ```javascript
    app.get('/products/:id', (req, res) => {
      console.log(req.params) // for route /products/1 { id: "1" }
-     console.log(req.query) // for route /products?page=1&pageSize=20 { page: "1", pageSize: "20"}
    })
    ```
 
-   **Query parameters** 
+   **Query parameters**
 
    ```javascript
    app.get('/products/', (req, res) => {
      console.log(req.query) // for route /products?page=1&pageSize=20 { page: "1", pageSize: "20"}
    })
    ```
 
-## Install
-
-```
-npm install mini-web
-```
-
 ## Create an app
 
 ```javascript
-const miniweb = require('quarkhttp');
+const quark = require('quarkhttp');
 
-const app = miniweb();
+const app = quark();
 
 // ROUTE PARAMETERS
 app.get("/products/:id", (req, res) => {
@@ -92,6 +90,12 @@ app.post('/products', (req,res) => {
   res.json(req.body);
 })
 
+// PUT
+app.put('/products', (req,res) => {
+  console.info('body', req.body)
+  res.json(req.body);
+})
+
 // MIDDLEWARE
 app.get('/orders', (req, res, next) => {
   if (req.headers['authorization'] === 'abc123') {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "quarkhttp",
-  "version": "0.8.3",
+  "version": "1.0.0",
   "engines": {
     "node": ">=10.0.0"
   },
@@ -31,7 +31,7 @@
     ]
   },
   "keywords": [
-    "mini-web",
+    "quarkhttp",
     "framework",
     "web",
     "http",