Updated the README.

simplepie · May 27, 2019 · c501db5 · c501db5
1 parent a4a768d
commit c501db5
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,35 @@
+<div align="center"><img src="https://github.com/raw/simplepie/.github/master/logo.png" width="500"><br></div>
+
+----
+
 # SimplePie RFC Documents
 
 Requests for Change documents. Similar to PSR, PEP, JSR, and other document-oriented changes.
 
 Documents will go by `SPEP`, which stands for _SimplePie Enhancement Proposal_. Since they may include other "metadata" documentation, each one will live in it's own subdirectory. This is the pattern adopted by the PHP-FIG, so there is some precedent there.
 
+## Badges
+
+### Health
+
+[![Open Issues](http://img.shields.io/github/issues/simplepie/rfc.svg?style=for-the-badge)](https://github.com/simplepie/rfc/issues)
+[![Pull Requests](https://img.shields.io/github/issues-pr/simplepie/rfc.svg?style=for-the-badge)](https://github.com/simplepie/rfc/pulls)
+[![Contributors](https://img.shields.io/github/contributors/simplepie/rfc.svg?style=for-the-badge)](https://github.com/simplepie/rfc/graphs/contributors)
+[![Repo Size](https://img.shields.io/github/repo-size/simplepie/rfc.svg?style=for-the-badge)](https://github.com/simplepie/rfc/pulse/monthly)
+[![GitHub Commit Activity](https://img.shields.io/github/commit-activity/y/simplepie/rfc.svg?style=for-the-badge)](https://github.com/simplepie/rfc/commits/master)
+[![GitHub Last Commit](https://img.shields.io/github/last-commit/simplepie/rfc.svg?style=for-the-badge)](https://github.com/simplepie/rfc/commits)
+
+### Social
+
+[![Author](http://img.shields.io/badge/author-@skyzyx-blue.svg?style=for-the-badge)](https://twitter.com/skyzyx)
+[![Follow](https://img.shields.io/twitter/follow/simplepie_ng.svg?style=for-the-badge&label=Follow%20@simplepie_ng)](https://twitter.com/intent/follow?screen_name=simplepie_ng)
+[![Blog](https://img.shields.io/badge/medium-simplepie--ng-blue.svg?style=for-the-badge)](https://medium.com/simplepie-ng)
+[![Stars](https://img.shields.io/github/stars/simplepie/rfc.svg?style=for-the-badge&label=GitHub%20Stars)](https://github.com/simplepie/rfc/stargazers)
+
+### Compliance
+
+[![License](https://img.shields.io/github/license/simplepie/rfc.svg?style=for-the-badge)](https://github.com/simplepie/rfc/blob/master/LICENSE.md)
+
 ## Common Terms
 
 1. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
@@ -45,3 +71,4 @@ TBD
 ### Obsolete
 
 TBD
+
diff --git a/templates/README.md.tmpl b/templates/README.md.tmpl
@@ -0,0 +1,53 @@
+@@HEADER@@
+
+# SimplePie RFC Documents
+
+Requests for Change documents. Similar to PSR, PEP, JSR, and other document-oriented changes.
+
+Documents will go by `SPEP`, which stands for _SimplePie Enhancement Proposal_. Since they may include other "metadata" documentation, each one will live in it's own subdirectory. This is the pattern adopted by the PHP-FIG, so there is some precedent there.
+
+## Badges
+
+@@DOCKER_BADGES;repo=rfc@@
+
+## Common Terms
+
+1. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
+
+1. "Support" or "Supported" refer to the fact that we (humans) will _provide support_ and/or _actively test_ particular software. It **does not** refer to (and makes no claims about) whether or not particular software _functions_ in a given environment context (machines).
+
+1. "SimplePie Core Team" is defined by [`simplepie/.github`](https://github.com/simplepie/.github).
+
+1. "SimplePie" refers to the overarching SimplePie project, which may include any of the sub-projects under the SimplePie umbrella. It does not implicitly or explicitly refer to any particular repository of code.
+
+1. "SimplePie NG", "Feed Locator", "Text Encoder", and other names refer to their specific project repositories.
+
+1. "SimplePie OG" refers to the original `simplepie/simplepie` repository, and is a play-on-words. In "SimplePie NG", the "NG" stands for _Next-Generation_. "NG" is similar to "OG", and "OG" is a slang acronym for _original gangsta_, or sometimes _old gee_, where "gee" is short for _gangsta_. From this term, we derive "original" (or "old"), referring to the original SimplePie project.
+
+## Expectation of Adoption
+
+These documents are expected to apply to all repositories (as appropriate) inside this GitHub organization with the following exceptions:
+
+1. Archived repositories are exempted from these documents.
+
+1. The original `simplepie/simplepie` repository (aka, "SimplePie Classic", "SimplePie OG") is exempted from these documents.
+
+## SimplePie Enhancement Proposal RFCs
+
+### Approved
+
+| # | Title |
+| - | ----- |
+| [SPEP-1](https://github.com/simplepie/rfc/tree/master/SPEP-1) | PHP Version Support Guidelines |
+
+### Pending/In-Progress
+
+TBD
+
+### Inactive
+
+TBD
+
+### Obsolete
+
+TBD