chore: rename to @koa/router

koajs · Jun 16, 2019 · b5dd5e8 · divmgl · Jun 17, 2019 · b5dd5e8
1 parent 49498ff
commit b5dd5e8
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,14 @@
 # koa-router
 
-[![NPM version](https://img.shields.io/npm/v/koa-router.svg?style=flat)](https://npmjs.org/package/koa-router) [![NPM Downloads](https://img.shields.io/npm/dm/koa-router.svg?style=flat)](https://npmjs.org/package/koa-router) [![Node.js Version](https://img.shields.io/node/v/koa-router.svg?style=flat)](http://nodejs.org/download/) [![Build Status](https://img.shields.io/travis/alexmingoia/koa-router.svg?style=flat)](http://travis-ci.org/alexmingoia/koa-router) [![Gitter Chat](https://img.shields.io/badge/gitter-join%20chat-1dce73.svg?style=flat)](https://gitter.im/alexmingoia/koa-router/)
+[![NPM version](https://img.shields.io/npm/v/@koa/router.svg?style=flat)](https://npmjs.org/package/@koa/router) [![NPM Downloads](https://img.shields.io/npm/dm/@koa/router.svg?style=flat)](https://npmjs.org/package/@koa/router) [![Node.js Version](https://img.shields.io/node/v/@koa/router.svg?style=flat)](http://nodejs.org/download/) [![Build Status](https://img.shields.io/travis/koajs/koa-router.svg?style=flat)](http://travis-ci.org/koajs/koa-router) [![Tips](https://img.shields.io/gratipay/koajs.svg?style=flat)](https://www.gratipay.com/koajs/) [![Gitter Chat](https://img.shields.io/badge/gitter-join%20chat-1dce73.svg?style=flat)](https://gitter.im/koajs/koa-router/)
+
+## Call for Mantainers
+
+This module if fork from [koa-router](https://github.com/ZijianHe/koa-router), the most widely used router module in koa
+community, because of it is lake of activity now. Thanks for the greate work of @alexmingoia and the original team.
+
+And now we need maintainers for this project. Anyone interested can creates pull requests to fixes bugs or implements
+new features, we will add active contributors as collaborators.
 
 > Router middleware for [koa](https://github.com/koajs/koa)
 
@@ -28,7 +36,7 @@
 Install using [npm](https://www.npmjs.org/):
 
 ```sh
-npm install koa-router
+npm install @koa/router
 ```
 
 ## API Reference
@@ -413,7 +421,7 @@ router
 ```
 <a name="module_koa-router--Router.url"></a>
 
-#### Router.url(path, params [, options]) ⇒ <code>String</code>
+#### Router.url(path, params) ⇒ <code>String</code>
 Generate URL from url pattern and given `params`.
 
 **Kind**: static method of <code>[Router](#exp_module_koa-router--Router)</code>  
@@ -422,25 +430,20 @@ Generate URL from url pattern and given `params`.
 | --- | --- | --- |
 | path | <code>String</code> | url pattern |
 | params | <code>Object</code> | url parameters |
-| [options] | <code>Object</code> | options parameter |
-| [options.query] | <code>Object</code> &#124; <code>String</code> | query options |
 
 **Example**  
 ```javascript
 var url = Router.url('/users/:id', {id: 1});
 // => "/users/1"
-
-const url = Router.url('/users/:id', {id: 1}, {query: { active: true }});
-// => "/users/1?active=true"
 ```
 ## Contributing
 
-Please submit all issues and pull requests to the [alexmingoia/koa-router](http://github.com/alexmingoia/koa-router) repository!
+Please submit all issues and pull requests to the [koajs/koa-router](http://github.com/koajs/koa-router) repository!
 
 ## Tests
 
 Run tests using `npm test`.
 
 ## Support
 
-If you have any problem or suggestion please open an issue [here](https://github.com/alexmingoia/koa-router/issues).
+If you have any problem or suggestion please open an issue [here](https://github.com/koajs/koa-router/issues).
diff --git a/history.md b/history.md
@@ -1,4 +1,6 @@
-# History
+-------------
+
+# Changelogs inherit from koa-router.
 
 ## 7.4.0
 

diff --git a/lib/README_tpl.hbs b/lib/README_tpl.hbs
@@ -1,6 +1,14 @@
-# koa-router
+# @koa/router
 
-[![NPM version](https://img.shields.io/npm/v/koa-router.svg?style=flat)](https://npmjs.org/package/koa-router) [![NPM Downloads](https://img.shields.io/npm/dm/koa-router.svg?style=flat)](https://npmjs.org/package/koa-router) [![Node.js Version](https://img.shields.io/node/v/koa-router.svg?style=flat)](http://nodejs.org/download/) [![Build Status](https://img.shields.io/travis/alexmingoia/koa-router.svg?style=flat)](http://travis-ci.org/alexmingoia/koa-router) [![Tips](https://img.shields.io/gratipay/alexmingoia.svg?style=flat)](https://www.gratipay.com/alexmingoia/) [![Gitter Chat](https://img.shields.io/badge/gitter-join%20chat-1dce73.svg?style=flat)](https://gitter.im/alexmingoia/koa-router/)
+[![NPM version](https://img.shields.io/npm/v/@koa/router.svg?style=flat)](https://npmjs.org/package/@koa/router) [![NPM Downloads](https://img.shields.io/npm/dm/@koa/router.svg?style=flat)](https://npmjs.org/package/@koa/router) [![Node.js Version](https://img.shields.io/node/v/@koa/router.svg?style=flat)](http://nodejs.org/download/) [![Build Status](https://img.shields.io/travis/koajs/koa-router.svg?style=flat)](http://travis-ci.org/koajs/koa-router) [![Tips](https://img.shields.io/gratipay/koajs.svg?style=flat)](https://www.gratipay.com/koajs/) [![Gitter Chat](https://img.shields.io/badge/gitter-join%20chat-1dce73.svg?style=flat)](https://gitter.im/koajs/koa-router/)
+
+## Call for Mantainers
+
+This module if fork from [koa-router](https://github.com/ZijianHe/koa-router), the most widely used router module in koa
+community, because of it is lake of activity now. Thanks for the greate work of @alexmingoia and the original team.
+
+And now we need maintainers for this project. Anyone interested can creates pull requests to fixes bugs or implements
+new features, we will add active contributors as collaborators.
 
 > Router middleware for [koa](https://github.com/koajs/koa)
 
@@ -28,7 +36,7 @@
 Install using [npm](https://www.npmjs.org/):
 
 ```sh
-npm install koa-router
+npm install @koa/router
 ```
 
 ## API Reference
@@ -40,12 +48,12 @@ npm install koa-router
 
 ## Contributing
 
-Please submit all issues and pull requests to the [alexmingoia/koa-router](http://github.com/alexmingoia/koa-router) repository!
+Please submit all issues and pull requests to the [koajs/koa-router](http://github.com/koajs/koa-router) repository!
 
 ## Tests
 
 Run tests using `npm test`.
 
 ## Support
 
-If you have any problem or suggestion please open an issue [here](https://github.com/alexmingoia/koa-router/issues).
+If you have any problem or suggestion please open an issue [here](https://github.com/koajs/koa-router/issues).
diff --git a/package.json b/package.json
@@ -1,16 +1,16 @@
 {
-  "name": "koa-router",
+  "name": "@koa/router",
   "description": "Router middleware for koa. Provides RESTful resource routing.",
   "repository": {
     "type": "git",
-    "url": "https://github.com/alexmingoia/koa-router.git"
+    "url": "https://github.com/koajs/koa-router.git"
   },
   "main": "lib/router.js",
   "files": [
     "lib"
   ],
   "author": "Alex Mingoia <talk@alexmingoia.com>",
-  "version": "7.4.0",
+  "version": "1.0.0",
   "keywords": [
     "koa",
     "middleware",