✏️ Writing docs
This commit is contained in:
Liyas Thomas
@@ -34,12 +34,12 @@ Examples of unacceptable behavior by participants include:
|
|||||||
## Our Responsibilities
|
## Our Responsibilities
|
||||||
|
|
||||||
Project maintainers are responsible for clarifying the standards of acceptable
|
Project maintainers are responsible for clarifying the standards of acceptable
|
||||||
behavior and are expected to take appropriate and fair corrective action in
|
behavior. Maintainers are expected to take appropriate and fair corrective action in
|
||||||
response to any instances of unacceptable behavior.
|
response to any instances of unacceptable behavior.
|
||||||
|
|
||||||
Project maintainers have the right and responsibility to remove, edit, or
|
Project maintainers have the right and responsibility to remove, edit, or
|
||||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
that are not aligned with our Code of Conduct, or to ban temporarily or
|
||||||
permanently any contributor for other behaviors that they deem inappropriate,
|
permanently any contributor for other behaviors that they deem inappropriate,
|
||||||
threatening, offensive, or harmful.
|
threatening, offensive, or harmful.
|
||||||
|
|
||||||
|
|||||||
@@ -13,8 +13,8 @@ Please note we have a code of conduct, please follow it in all your interactions
|
|||||||
variables, exposed ports, useful file locations and container parameters.
|
variables, exposed ports, useful file locations and container parameters.
|
||||||
3. Increase the version numbers in any examples files and the README.md to the new version that this
|
3. Increase the version numbers in any examples files and the README.md to the new version that this
|
||||||
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
|
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
|
||||||
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
|
4. You may merge the Pull Request once you have the sign-off of two other developers, or if you
|
||||||
do not have permission to do that, you may request the second reviewer to merge it for you.
|
do not have permission to do that, you may request the second reviewer merge it for you.
|
||||||
|
|
||||||
## Code of Conduct
|
## Code of Conduct
|
||||||
|
|
||||||
@@ -52,12 +52,12 @@ advances
|
|||||||
### Our Responsibilities
|
### Our Responsibilities
|
||||||
|
|
||||||
Project maintainers are responsible for clarifying the standards of acceptable
|
Project maintainers are responsible for clarifying the standards of acceptable
|
||||||
behavior and are expected to take appropriate and fair corrective action in
|
behavior. Maintainers are expected to take appropriate and fair corrective action in
|
||||||
response to any instances of unacceptable behavior.
|
response to any instances of unacceptable behavior.
|
||||||
|
|
||||||
Project maintainers have the right and responsibility to remove, edit, or
|
Project maintainers have the right and responsibility to remove, edit, or
|
||||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
that are not aligned with our Code of Conduct, or to ban temporarily or
|
||||||
permanently any contributor for other behaviors that they deem inappropriate,
|
permanently any contributor for other behaviors that they deem inappropriate,
|
||||||
threatening, offensive, or harmful.
|
threatening, offensive, or harmful.
|
||||||
|
|
||||||
|
|||||||
76
README.md
76
README.md
@@ -336,13 +336,75 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
|
|||||||
|
|
||||||
## Badges
|
## Badges
|
||||||
|
|
||||||
| Status | Preview | Markdown code (copy & paste into `readme.md`) |
|
<p>
|
||||||
| ----------- | ----------- | ----------- |
|
|
||||||
| **Default** | [](https://postwoman.io) | `[](https://postwoman.io)` |
|
[](https://postwoman.io)
|
||||||
| **Success** | [](https://postwoman.io) | `[](https://postwoman.io)` |
|
<details>
|
||||||
| **Critical** | [](https://postwoman.io) | `[](https://postwoman.io)` |
|
<summary>Default</summary>
|
||||||
| **Custom** | [](https://postwoman.io) | `[](https://postwoman.io)` |
|
<p>
|
||||||
| Customize | [](https://postwoman.io) | `[](https://postwoman.io)` |
|
|
||||||
|
```
|
||||||
|
[](https://postwoman.io)
|
||||||
|
```
|
||||||
|
</p>
|
||||||
|
</details>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
---
|
||||||
|
[](https://postwoman.io)
|
||||||
|
<details>
|
||||||
|
<summary>Success</summary>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
```
|
||||||
|
[](https://postwoman.io)
|
||||||
|
```
|
||||||
|
</p>
|
||||||
|
</details>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
---
|
||||||
|
[](https://postwoman.io)
|
||||||
|
<details>
|
||||||
|
<summary>Critical</summary>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
```
|
||||||
|
[](https://postwoman.io)
|
||||||
|
```
|
||||||
|
</p>
|
||||||
|
</details>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
---
|
||||||
|
[](https://postwoman.io)
|
||||||
|
<details>
|
||||||
|
<summary>Custom</summary>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
```
|
||||||
|
[](https://postwoman.io)
|
||||||
|
```
|
||||||
|
</p>
|
||||||
|
</details>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
---
|
||||||
|
[](https://postwoman.io)
|
||||||
|
<details>
|
||||||
|
<summary>Customize</summary>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
```
|
||||||
|
[](https://postwoman.io)
|
||||||
|
```
|
||||||
|
</p>
|
||||||
|
</details>
|
||||||
|
</p>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<br>
|
<br>
|
||||||
|
|||||||
Reference in New Issue
Block a user