Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ADD: Add Chinese version of this README template #14

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 78 additions & 0 deletions Chinese/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# 项目名称
> 对此项目做了什么进行简短的介绍。

[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Downloads Stats][npm-downloads]][npm-url]

一到两个段落来描述你的产品,以及它可以可以做些什么。

![](../header.png)

## 安装

macOS或者Linux

```sh
npm install my-crazy-module --save
```

Windows:

```sh
edit autoexec.bat
```

## 示例

对你的产品如何使用列举一些有鼓励性且有用的例子,用代码和截图来润色会使得这些例子更有趣。

_更多例子和使用介绍,请点击[Wiki][wiki]._

## 开发环境搭建

描述下项目依赖,以及怎样进行友好的自动化测试,并尽可能提供跨平台的解决方案。

```sh
make install
npm test
```

## 发布历史

* 0.2.1
* 改动: 更新文档 (模块代码未被改变)
* 0.2.0
* 改动: 移除 `setDefaultXYZ()`
* 新增: 添加 `init()`
* 0.1.1
* 修复: 当调用`baz()`时引发的崩溃 (感谢 @贡献者名单!)
* 0.1.0
* 第一版正式的发布
* 改动: 将 `foo()` 重命名为 `bar()`
* 0.0.1
* 开发中

## Meta

你的昵称 – [@推特](https://twitter.com/dbader_org) – 邮箱名@example.com

使用xyz协议分发. 更多信息请查看 ``LICENSE`` 文件。

[https://github.com/用户名/项目名](https://github.com/dbader/)

## 如何贡献代码

1. 拷贝项目 (<https://github.com/yourname/yourproject/fork>)
2. 创建一个适合的分支名 (`git checkout -b feature/fooBar`)
3. 提交你的改动 (`git commit -am 'Add some fooBar'`)
4. 推送此分支的改动到远端仓库 (`git push origin feature/fooBar`)
5. 创建一个PR,让作者看到合并请求。

<!-- Markdown link & img dfn's -->
[npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square
[npm-url]: https://npmjs.org/package/datadog-metrics
[npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square
[travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/dbader/node-datadog-metrics
[wiki]: https://github.com/yourname/yourproject/wiki