Skip to content

Commit f3bafc8

Browse files
committed
Readme files updates.
1 parent 6474f5c commit f3bafc8

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# WP Hooks Documentor
22

3-
A powerful tool to generate beautiful documentation for WordPress plugin hooks.
3+
> A powerful tool to generate beautiful documentation for WordPress plugin hooks.
4+
5+
6+
[![Support Level](https://img.shields.io/badge/support-beta-blueviolet.svg)](#support-level) [![Release Version](https://img.shields.io/github/release/10up/wp-hooks-documentor.svg)](https://github.com/10up/wp-hooks-documentor/releases/latest) [![License](https://img.shields.io/github/license/10up/wp-hooks-documentor.svg)](https://github.com/10up/wp-hooks-documentor/blob/develop/LICENSE.md) [![CodeQL](https://github.com/10up/wp-hooks-documentor/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/10up/wp-hooks-documentor/actions/workflows/codeql-analysis.yml)
7+
48

59
## Features
610

@@ -86,3 +90,19 @@ The tool uses a single configuration file (`wp-hooks-doc.json`) to control all a
8690

8791
The documentation site uses Docusaurus, which means you can fully customize the theme. See the [Docusaurus documentation](https://docusaurus.io/docs/styling-layout) for more details.
8892

93+
94+
## Support Level
95+
96+
**Beta:** This project is quite new and we're not sure what our ongoing support level for this will be. Bug reports, feature requests, questions, and pull requests are welcome. If you like this project please let us know, but be cautious using this in a Production environment!
97+
98+
## Changelog
99+
100+
A complete listing of all notable changes to Repo Automator - GitHub Action are documented in [CHANGELOG.md](https://github.com/10up/wp-hooks-documentor/blob/develop/CHANGELOG.md).
101+
102+
## Contributing
103+
104+
Please read [CODE_OF_CONDUCT.md](https://github.com/10up/wp-hooks-documentor/blob/develop/CODE_OF_CONDUCT.md) for details on our code of conduct, [CONTRIBUTING.md](https://github.com/10up/wp-hooks-documentor/blob/develop/CONTRIBUTING.md) for details on the process for submitting pull requests to us, and [CREDITS.md](https://github.com/10up/wp-hooks-documentor/blob/develop/CREDITS.md) for a list of maintainers, contributors, and libraries used in this repository.
105+
106+
## Like what you see?
107+
108+
<a href="http://10up.com/contact/"><img src="https://github.com/10up/.github/blob/trunk/profile/10up-github-banner.jpg" width="850" alt="Work with the 10up WordPress Practice at Fueled"></a>

0 commit comments

Comments
 (0)