From 0211114475754c064f643b6e36b382e9c9298312 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Tue, 10 Dec 2019 10:12:43 -0500 Subject: [PATCH] Remove blockquote from short description Closes #22 --- LICENSE | 2 +- README.cn.md | 2 +- README.md | 2 +- example-readmes/maximal-readme.md | 2 +- example-readmes/minimal-readme.md | 2 +- package.json | 2 +- spec.md | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/LICENSE b/LICENSE index 50a7a14..9dd8954 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2017 Richard Littauer +Copyright (c) 2017-2019 Richard Littauer Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.cn.md b/README.cn.md index 386fbd2..4f52e8d 100644 --- a/README.cn.md +++ b/README.cn.md @@ -2,7 +2,7 @@ [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) -> 标准 Readme 样式 +标准 Readme 样式 README 文件是人们通常最先看到的第一个东西。它应该告诉人们为什么要使用、如何安装、以及如何使用你的代码。README 文件标准化能够使得创建和维护 README 文件更加简单。 毕竟，要写好一个文档不是那么容易的。 diff --git a/README.md b/README.md index 8dd1d40..ad19584 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) -> Standard Readme Style +A standard style for README files Your README file is normally the first entry point to your code. It should tell people why they should use your module, how they can install it, and how they can use it. Standardizing how you write your README makes creating and maintaining your READMEs easier. Great documentation takes work! diff --git a/example-readmes/maximal-readme.md b/example-readmes/maximal-readme.md index 2246906..355e8b6 100644 --- a/example-readmes/maximal-readme.md +++ b/example-readmes/maximal-readme.md @@ -7,7 +7,7 @@ [![license](https://img.shields.io/github/license/:user/:repo.svg)](LICENSE) [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) -> This is an example file with maximal choices selected. +This is an example file with maximal choices selected. This is a long description. diff --git a/example-readmes/minimal-readme.md b/example-readmes/minimal-readme.md index 3ea3021..13d94b7 100644 --- a/example-readmes/minimal-readme.md +++ b/example-readmes/minimal-readme.md @@ -1,6 +1,6 @@ # Title -> This is an example file with default selections. +This is an example file with default selections. ## Install diff --git a/package.json b/package.json index c25b1f3..f561156 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "standard-readme-spec", "version": "1.1.5", - "description": "Readme Standard Style", + "description": "A standard style for README files", "bin": "cat.sh", "repository": { "type": "git", diff --git a/spec.md b/spec.md index 210a533..c198ead 100644 --- a/spec.md +++ b/spec.md @@ -78,7 +78,7 @@ _Note: This is only a navigation guide for the specification, and does not defin **Requirements:** - Must not have its own title. - Must be less than 120 characters. -- Must start with `> ` +- Must not start with `> ` - Must be on its own line. - Must match the description in the packager manager's `description` field. - Must match GitHub's description (if on GitHub).