update readme for now situation

README.md

@@ -1,10 +1,9 @@
 cnpmjs.org
 =======
 
-[![NPM version][npm-image]][npm-url]
+[![npm version][npm-image]][npm-url]
 [![build status][travis-image]][travis-url]
 [![Test coverage][codecov-image]][codecov-url]
-[![David deps][david-image]][david-url]
 [![Known Vulnerabilities][snyk-image]][snyk-url]
 [![npm download][download-image]][download-url]
 
@@ -14,8 +13,6 @@ cnpmjs.org
 [travis-url]: https://travis-ci.org/cnpm/cnpmjs.org
 [codecov-image]: https://codecov.io/gh/cnpm/cnpmjs.org/branch/master/graph/badge.svg
 [codecov-url]: https://codecov.io/gh/cnpm/cnpmjs.org
-[david-image]: https://img.shields.io/david/cnpm/cnpmjs.org.svg?style=flat-square
-[david-url]: https://david-dm.org/cnpm/cnpmjs.org
 [snyk-image]: https://snyk.io/test/npm/cnpmjs.org/badge.svg?style=flat-square
 [snyk-url]: https://snyk.io/test/npm/cnpmjs.org
 [download-image]: https://img.shields.io/npm/dm/cnpmjs.org.svg?style=flat-square
@@ -23,51 +20,43 @@ cnpmjs.org
 
 ![logo](https://raw.github.com/cnpm/cnpmjs.org/master/logo.png)
 
-## What is this?
+## Description
 
 Private npm registry and web for Enterprise, base on [koa](http://koajs.com/),
 MySQL and [Simple Store Service](https://github.com/cnpm/cnpmjs.org/wiki/NFS-Guide).
 
-Our goal is to provide a low cost maintenance and easy to use solution for private npm.
+Our goal is to provide a low cost maintenance, easy to use, and easy to scale solution for private npm.
 
-## What can you do with `cnpmjs.org`
+## What can you do with `cnpmjs.org`?
 
 * Build a private npm for your own enterprise. ([alibaba](http://www.alibaba.com/) is using `cnpmjs.org` now)
-* Build a mirror NPM. (we use it to build a mirror in China: [cnpmjs.org](http://cnpmjs.org/))
-* Build a completely independent NPM registry to store whatever you like.
+* Build a npm mirror. (we use it to build a mirror in China: [https://npm.taobao.org/](https://npm.taobao.org/))
 
 ## Features
 
 * **Support "scoped" packages**: [npm/npm#5239](https://github.com/npm/npm/issues/5239)
 * **Support [CORS](http://en.wikipedia.org/wiki/Cross-origin_resource_sharing)**
 * **Simple to deploy**: only need `mysql` and a [simple store system](https://github.com/cnpm/cnpmjs.org/wiki/NFS-Guide).
-You can get the source code through `npm` or `git`.
-* **Low cost and easy maintenance**: `package.json` info store in MySQL, MariaDB, SQLite or PostgreSQL databases,
-tarball(tgz file) store in CDN or other store systems.
-* **Automatic synchronization**: automatic synchronization from any registry specified, support two sync modes:
-  - Sync all modules from a specified registry, like [npm registry](http://registry.npmjs.org).
-  - Only sync the modules that exists in your own registry.
-* **Manual synchronization**: automatic synchronization may has little delay, but you can syn immediately by manually.
+* **Low cost and easy maintenance**: `package.json` info can store in MySQL, MariaDB, SQLite or PostgreSQL.
+tarball(tgz file) can store in Amazon S3 or other object storage service.
+* **Automatic synchronization**: automatically sync from any registry specified. support two sync modes:
+  - Sync all modules from upstream
+  - Only sync the modules after first access.
+* **Manual synchronization**: automatic synchronization may has little delay. you can sync manually on web page.
 * **Customized client**: we provide a client [cnpm](https://github.com/cnpm/cnpm)
 to extend `npm` with more features(`sync` command, [gzip](https://github.com/npm/npm-registry-client/pull/40) support).
-And it easy to wrap for your own registry which build with `cnpmjs.org`.
-* **Compatible with NPM client**: you can use the origin NPM client with `cnpmjs.org`,
-only need to change the registry in config. Even include manual synchronization (through `install` command).
-* **Version badge**: base on [shields.io](http://shields.io/) ![cnpm-badge](http://cnpmjs.org/badge/v/cnpmjs.org.svg?style=flat-square)
-* **Support http_proxy**: if you're behind firewall, need to request through http proxy
+And it is easy to wrap for your own registry which build with `cnpmjs.org`.
+* **Compatible with npm client**: you can use the official npm client with `cnpmjs.org`.
+you only need to change the registry in client config.
+* **Support http_proxy**: if you're behind a firewall, you can provide a http proxy for cnpmjs.org.
 
-**PROTIP** Be sure to read [Migrating from 1.x to 2.x](https://github.com/cnpm/cnpmjs.org/wiki/Migrating-from-1.x-to-2.x)
-as well as [New features in 2.x](https://github.com/cnpm/cnpmjs.org/wiki/New-features-in-2.x).
+## Docs
 
-## Getting Start
-
-* [Deploy a private npm registry in 5 minutes](https://github.com/cnpm/cnpmjs.org/wiki/Deploy-a-private-npm-registry-in-5-minutes)
-* @[dead-horse](https://github.com/dead-horse): [What is cnpm?](http://deadhorse.me/slides/cnpmjs.html)
-* install and deploy cnpmjs.org through npm: [examples](https://github.com/cnpm/custom-cnpm-example)
-* Mirror NPM in China: [cnpmjs.org](http://cnpmjs.org)
+* [How to deploy](https://github.com/cnpm/cnpmjs.org/wiki/Deploy)
 * cnpm client: [cnpm](https://github.com/cnpm/cnpm), `npm install -g cnpm`
-* [How to deploy cnpmjs.org](https://github.com/cnpm/cnpmjs.org/wiki/Deploy)
 * [Sync packages through `http_proxy`](https://github.com/cnpm/cnpmjs.org/wiki/Sync-packages-through-http_proxy)
+* [Migrating from 1.x to 2.x](https://github.com/cnpm/cnpmjs.org/wiki/Migrating-from-1.x-to-2.x)
+* [New features in 2.x](https://github.com/cnpm/cnpmjs.org/wiki/New-features-in-2.x).
 * [wiki](https://github.com/cnpm/cnpmjs.org/wiki)
 
 ## Develop on your local machine
@@ -105,7 +94,7 @@ $ make dev
 
 ### Dockerized cnpmjs.org Installation Guide
 
-Cnpmjs.org shipped with a simple but pragmatic Docker Compose configuration.With the configuration, you can set up a MySQL backed cnpmjs.org instance by executing just one command on Docker installed environment.
+Cnpmjs.org shipped with a simple but pragmatic Docker Compose configuration.With the configuration, you can set up a MySQL backend cnpmjs.org instance by executing just one command on Docker installed environment.
 
 #### Preparation
 
@@ -183,7 +172,6 @@ Tips: make sure your code is following the [node-style-guide](https://github.com
 ## Sponsors
 
 - [![阿里云](https://static.aliyun.com/images/www-summerwind/logo.gif)](http://click.aliyun.com/m/4288/) (2016.2 - now)
-- [![UCloud云计算](https://www.ucloud.cn/static/style/images/about/logo.png)](http://www.ucloud.cn?sem=sdk-CNPMJS) (2015.3 - 2016.3)
 
 ## License
 

common/sequelize.js

@@ -48,7 +48,7 @@ database.syncFirst = false;
 
 // add longtext for mysql
 Sequelize.LONGTEXT = DataTypes.LONGTEXT = DataTypes.TEXT;
-if (database.dialect === 'mysql') {
+if (config.dialect === 'mysql') {
   Sequelize.LONGTEXT = DataTypes.LONGTEXT = 'LONGTEXT';
 }
 
@@ -56,8 +56,8 @@ database.define = {
   timestamps: true,
   createdAt: 'gmt_create',
   updatedAt: 'gmt_modified',
-  charset: 'utf8mb4',
-  collate: 'utf8mb4_unicode_ci',
+  charset: 'utf8',
+  collate: 'utf8_general_ci',
 };
 
 var sequelize = new Sequelize(database.db, database.username, database.password, database);

config/index.js

@@ -140,7 +140,6 @@ var config = {
     dialectOptions: {
       // if your server run on full cpu load, please set trace to false
       trace: true,
-      charset: 'utf8mb4',
     },
 
     // the storage engine for 'sqlite'

docs/db.sql

@@ -81,7 +81,7 @@ CREATE TABLE IF NOT EXISTS `module` (
  `gmt_modified` datetime NOT NULL COMMENT 'modified time',
  `author` varchar(100) NOT NULL COMMENT 'module author',
  `name` varchar(214) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL COMMENT 'module name',
- `version` varchar(70) NOT NULL COMMENT 'module version',
+ `version` varchar(30) NOT NULL COMMENT 'module version',
  `description` longtext COMMENT 'module description',
  `package` longtext CHARACTER SET utf8 COLLATE utf8_general_ci COMMENT 'package.json',
  `dist_shasum` varchar(100) DEFAULT NULL COMMENT 'module dist SHASUM',
@@ -116,7 +116,7 @@ CREATE TABLE IF NOT EXISTS `module_abbreviated` (
  `gmt_create` datetime NOT NULL COMMENT 'create time',
  `gmt_modified` datetime NOT NULL COMMENT 'modified time',
  `name` varchar(214) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL COMMENT 'module name',
- `version` varchar(70) NOT NULL COMMENT 'module version',
+ `version` varchar(30) NOT NULL COMMENT 'module version',
  `package` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci COMMENT 'the abbreviated metadata',
  `publish_time` bigint(20) unsigned COMMENT 'the publish time',
  PRIMARY KEY (`id`),
@@ -134,7 +134,7 @@ CREATE TABLE IF NOT EXISTS `package_readme` (
  `gmt_modified` datetime NOT NULL COMMENT 'modified time',
  `name` varchar(214) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL COMMENT 'module name',
  `readme` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci COMMENT 'the latest version readme',
- `version` varchar(70) NOT NULL COMMENT 'module version',
+ `version` varchar(30) NOT NULL COMMENT 'module version',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_name` (`name`),
  KEY `idx_gmt_modified` (`gmt_modified`)
@@ -164,7 +164,7 @@ CREATE TABLE IF NOT EXISTS `tag` (
  `gmt_modified` datetime NOT NULL COMMENT 'modified time',
  `name` varchar(214) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL COMMENT 'module name',
  `tag` varchar(30) NOT NULL COMMENT 'tag name',
- `version` varchar(70) NOT NULL COMMENT 'module version',
+ `version` varchar(30) NOT NULL COMMENT 'module version',
  `module_id` bigint(20) unsigned NOT NULL COMMENT 'module id',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_name` (`name`, `tag`),

models/module.js

@@ -21,7 +21,7 @@ CREATE TABLE IF NOT EXISTS `module` (
  `gmt_modified` datetime NOT NULL COMMENT 'modified time',
  `author` varchar(100) NOT NULL COMMENT 'module author',
  `name` varchar(214) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL COMMENT 'module name',
- `version` varchar(70) NOT NULL COMMENT 'module version',
+ `version` varchar(30) NOT NULL COMMENT 'module version',
  `description` longtext COMMENT 'module description',
  `package` longtext CHARACTER SET utf8 COLLATE utf8_general_ci COMMENT 'package.json',
  `dist_shasum` varchar(100) DEFAULT NULL COMMENT 'module dist SHASUM',
@@ -49,7 +49,7 @@ module.exports = function (sequelize, DataTypes) {
       comment: 'module name'
     },
     version: {
-      type: DataTypes.STRING(70),
+      type: DataTypes.STRING(30),
       allowNull: false,
       comment: 'module version'
     },

models/module_abbreviated.js

@@ -6,7 +6,7 @@ CREATE TABLE IF NOT EXISTS `module_abbreviated` (
  `gmt_create` datetime NOT NULL COMMENT 'create time',
  `gmt_modified` datetime NOT NULL COMMENT 'modified time',
  `name` varchar(214) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL COMMENT 'module name',
- `version` varchar(70) NOT NULL COMMENT 'module version',
+ `version` varchar(30) NOT NULL COMMENT 'module version',
  `package` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci COMMENT 'the abbreviated metadata',
  `publish_time` bigint(20) unsigned COMMENT 'the publish time',
  PRIMARY KEY (`id`),
@@ -24,7 +24,7 @@ module.exports = function (sequelize, DataTypes) {
       comment: 'module name'
     },
     version: {
-      type: DataTypes.STRING(70),
+      type: DataTypes.STRING(30),
       allowNull: false,
       comment: 'module version'
     },

models/package_readme.js

@@ -7,7 +7,7 @@ CREATE TABLE IF NOT EXISTS `package_readme` (
  `gmt_modified` datetime NOT NULL COMMENT 'modified time',
  `name` varchar(214) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL COMMENT 'module name',
  `readme` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci COMMENT 'the latest version readme',
- `version` varchar(70) NOT NULL COMMENT 'module version',
+ `version` varchar(30) NOT NULL COMMENT 'module version',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_name` (`name`),
  KEY `idx_gmt_modified` (`gmt_modified`)
@@ -22,7 +22,7 @@ module.exports = function (sequelize, DataTypes) {
       comment: 'module name'
     },
     version: {
-      type: DataTypes.STRING(70),
+      type: DataTypes.STRING(30),
       allowNull: false,
       comment: 'module latest version'
     },

models/tag.js

@@ -21,7 +21,7 @@ CREATE TABLE IF NOT EXISTS `tag` (
  `gmt_modified` datetime NOT NULL COMMENT 'modified time',
  `name` varchar(214) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL COMMENT 'module name',
  `tag` varchar(30) NOT NULL COMMENT 'tag name',
- `version` varchar(70) NOT NULL COMMENT 'module version',
+ `version` varchar(30) NOT NULL COMMENT 'module version',
  `module_id` bigint(20) unsigned NOT NULL COMMENT 'module id',
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_name` (`name`, `tag`),
@@ -42,7 +42,7 @@ module.exports = function (sequelize, DataTypes) {
       comment: 'tag name',
     },
     version: {
-      type: DataTypes.STRING(70),
+      type: DataTypes.STRING(30),
       allowNull: false,
       comment: 'module version',
     },