README

入门

在这里列出启动我的项目的步骤。

以下是在README.md文件中使用示例。

网站标题

任何GitHub标签。

在此处简要描述。

演示：链接到演示

快速入门

有几个快速入门选项可用

这里列出下载1
这里还有另一个下载选项
再次提供另一个选项

在入门页面上的“阅读我”处 - 放置链接。

包含内容

在下载中，您将找到以下目录和文件

root/
├── css/
│   ├-- project.css.map
│   ├── project.css.map
│   ├── project.min.css
│   ├── project-theme.css
│   ├── project-theme.css.map
│   └── project-theme.min.css
├── js/
│   ├── project.js
│   └── project.min.js
└── fonts/
    ├── project.eot
    ├── project.svg
    ├── project.ttf
    ├── project.woff
    └── project.woff2

错误和功能请求

描述如何报告错误和添加功能请求。

文档

链接到文档 docs

本地运行文档

列出获取本地文档的步骤。

以前版本文档

描述如何获取以前版本的文档。

以前版本

贡献

写下如何为项目做出贡献。开源贡献是很有趣的！

社区

跟踪开发和社区新闻。

关注@thadbry on Twitter。
阅读并订阅官方项目博客。
在IRC中与同行聊天。在irc.freenode.net服务器上的##whatever频道。
在Stack Overflow（标签为project）上可能找到实现帮助。

版本控制

为了提高发布周期的透明度并努力保持向后兼容性，本项目遵循语义版本控制指南。尽可能遵守这些规则。有时我们会出错。

创建者

Thad Bryson

版权和许可

在此处放置代码和文档的许可协议。我不推荐任何特定的许可，因为我不想提供法律建议。我在任何州都没有法律执业资格。我在此项目中使用的许可链接如下。本项目的main README.md文件包含许可证。

代码在MIT许可下发布。文档在Creative Commons下发布。

raorsa / sage-middleware-client

维护者

详细信息