Skip to content

Commit f1ec427

Browse files
author
Aaron Schlesinger
committed
doc(README.md): update the readme to reflect beta status
1 parent 3747ba3 commit f1ec427

1 file changed

Lines changed: 29 additions & 5 deletions

File tree

README.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,36 @@
1-
# Registry
1+
# Deis Registry v2
22

33
[![Build Status](https://travis-ci.org/deis/registry.svg?branch=master)](https://travis-ci.org/deis/registry)
4+
[![Go Report Card](http://goreportcard.com/badge/deis/registry)](http://goreportcard.com/report/deis/registry)
5+
[![Docker Repository on Quay](https://quay.io/repository/deisci/registry/status "Docker Repository on Quay")](https://quay.io/repository/deisci/registry)
46

5-
A Docker image registry for use in the Deis open source PaaS.
6-
7-
This Docker image is based on alpine linux and uses the official Docker V2 registry code.
87

98
Deis (pronounced DAY-iss) is an open source PaaS that makes it easy to deploy and manage
109
applications on your own servers. Deis builds on [Kubernetes](http://kubernetes.io/) to provide
1110
a lightweight, [Heroku-inspired](http://heroku.com) workflow.
1211

12+
## Beta Status
13+
14+
This Deis component is currently in beta status, and we welcome your input! If you have feedback, please submit an [issue][issues]. If you'd like to participate in development, please read the "Development" section below and submit a [pull request][prs].
15+
16+
# About
17+
18+
The registry is a [Docker registry](https://docs.docker.com/registry/) component for use in Kubernetes. While it's intended for use inside of the Deis open source [PaaS](https://en.wikipedia.org/wiki/Platform_as_a_service), it's flexible enough to be used as a standalone pod on any Kubernetes cluster.
19+
20+
If you decide to use this component standalone, you can host your own Docker registry in your own Kubernetes cluster.
21+
22+
The Docker image that this repository builds is based on [Alpine Linux](http://www.alpinelinux.org/) and uses [the Deis fork](https://github.com/deis/distribution) of [the official Docker v2 registry code](https://github.com/docker/distribution).
23+
24+
# Development
25+
26+
The Deis project welcomes contributions from all developers. The high level process for development matches many other open source projects. See below for an outline.
27+
28+
* Fork this repository
29+
* Make your changes
30+
* Submit a pull request (PR) to this repository with your changes, and unit tests whenever possible.
31+
* If your PR fixes any issues, make sure you write Fixes #1234 in your PR description (where #1234 is the number of the issue you're closing)
32+
* The Deis core contributors will review your code. After each of them sign off on your code, they'll label your PR with LGTM1 and LGTM2 (respectively). Once that happens, the contributors will merge it
33+
1334
## Deploying
1435

1536
If you want to use the latest registry image built by they Deis team you can simply start a registry via `make deploy`.
@@ -82,8 +103,11 @@ $ kubectl exec -it registry-6wy8o sh
82103

83104
## License
84105

85-
© 2014 Engine Yard, Inc.
106+
© 2014, 2015, 2016 Engine Yard, Inc.
86107

87108
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at <http://www.apache.org/licenses/LICENSE-2.0>
88109

89110
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
111+
112+
[issues]: https://github.com/deis/registry/issues
113+
[prs]: https://github.com/deis/registry/pulls

0 commit comments

Comments
 (0)