当前位置：文江博客 Node Package Readme README.md 中文文档教程

README.md 中文文档教程

发布于 7年前浏览 60 项目主页更新于 3年前

readme.md

readme.md 是一个可以轻松更新的应用程序 package.json 文件包含 README.md 中的内容。

为了安装它，您可以运行：

$ npm install -g readme.md

然后在您开发的项目中您可以再次运行：

$ readme-md-update

这将更新您的 package.json 文件，设置 JSON 转义文件的自述内容。

如果您想更新不同的文件，或阅读不同的文件，或使用不同的属性，您可以也可以直接使用：

var readme = require("readme.md");
readme.writeFileIntoJson("README.md", "package.json", "readme");

readme.md is an application that allows easy updating of package.json files with the content from the README.md.

In order to install it you can run:

$ npm install -g readme.md

Then in the project that you develop you can run again:

$ readme-md-update

This will update your package.json file, setting the readme contents to the JSON escaped file.

In case you want to update a different file, or read a different file, or use a different property, you can also use it directly:

var readme = require("readme.md");
readme.writeFileIntoJson("README.md", "package.json", "readme");