Skip to content

Commit ac58fbb

Browse files
committed
Update docs
1 parent 26c7ce7 commit ac58fbb

File tree

3 files changed

+84
-15
lines changed

3 files changed

+84
-15
lines changed

CODE_OF_CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at admin@orleika.io. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
FROM alpine:latest
22

3-
MAINTAINER orleika <orleika.net@gmail.com>
3+
MAINTAINER orleika <admin@orleika.io>
44

55
ARG NGINX_VERSION=1.11.10
66
ARG LIBRESSL_VERSION=2.5.1

README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,20 @@
1-
# docker-nginx
1+
# Docker Nginx Image _(docker-nginx)_
22

3-
[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://orleika.github.io/mit-license)
43
[![Build Status](https://img.shields.io/travis/orleika/docker-nginx/master.svg?style=flat-square)](https://travis-ci.org/orleika/docker-nginx)
54
[![nginx](http://img.shields.io/badge/nginx-v1.11.10-blue.svg?style=flat-square)](https://nginx.org/en/download.html)
65
[![LibreSSL](http://img.shields.io/badge/LibreSSL-v2.5.1-blue.svg?style=flat-square)](https://www.libressl.org/)
7-
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
6+
[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://orleika.github.io/mit-license)
87

9-
> nginx docker image
8+
> docker nginx image
109
11-
Small-Secure-Fast nginx docker image.
10+
Small-Secure-Fast docker nginx image.
1211
Base image is alpine, which is a security-oriented, lightweight Linux distribution. Most response headers are concealed, and DDoS mitigation is equipped. You should use secure headers included in `conf.d` for further safety considerations. Additionally, nginx caching parameters are optimized.
1312
This image is automatically released by Docker Cloud.
1413

15-
## Table of Contents
16-
17-
- [Install](#install)
18-
- [Usage](#usage)
19-
- [Contribute](#contribute)
20-
- [License](#license)
21-
2214
## Install
2315

16+
This project uses [docker](https://docs.docker.com). Go check them out if you don't have them locally installed.
17+
2418
```sh
2519
$ docker pull orleika/nginx
2620
```
@@ -33,8 +27,9 @@ $ docker run -d -p 80:80 orleika/nginx
3327

3428
## Contribute
3529

36-
PRs accepted.
30+
Please open [issues](https://github.com/orleika/docker-nginx/issues/new) or submit Pull requests to report bugs, features, or other problems.
31+
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
3732

3833
## License
3934

40-
MIT © orleika
35+
[MIT © orleika](LICENSE)

0 commit comments

Comments
 (0)