Merge pull request #9910 from crosbymichael/update-readme-fred

Minor copy edits and updates to README
This commit is contained in:
Michael Crosby 2015-01-05 15:46:58 -08:00
commit fcc4ba5ec8
1 changed files with 22 additions and 20 deletions

View File

@ -5,14 +5,14 @@ Docker is an open source project to pack, ship and run any application
as a lightweight container as a lightweight container
Docker containers are both *hardware-agnostic* and *platform-agnostic*. Docker containers are both *hardware-agnostic* and *platform-agnostic*.
This means that they can run anywhere, from your laptop to the largest This means they can run anywhere, from your laptop to the largest
EC2 compute instance and everything in between - and they don't require EC2 compute instance and everything in between - and they don't require
that you use a particular language, framework or packaging system. That you to use a particular language, framework or packaging system. That
makes them great building blocks for deploying and scaling web apps, makes them great building blocks for deploying and scaling web apps,
databases and backend services without depending on a particular stack databases, and backend services without depending on a particular stack
or provider. or provider.
Docker is an open-source implementation of the deployment engine which Docker began as an open-source implementation of the deployment engine which
powers [dotCloud](http://dotcloud.com), a popular Platform-as-a-Service. powers [dotCloud](http://dotcloud.com), a popular Platform-as-a-Service.
It benefits directly from the experience accumulated over several years It benefits directly from the experience accumulated over several years
of large-scale operation and support of hundreds of thousands of of large-scale operation and support of hundreds of thousands of
@ -22,7 +22,7 @@ applications and databases.
## Security Disclosure ## Security Disclosure
Security is very important to us. If you have any issue regarding security, Security is very important to us. If you have any issue regarding security,
please disclose the information responsibly by sending an email to please disclose the information responsibly by sending an email to
security@docker.com and not by creating a github issue. security@docker.com and not by creating a github issue.
@ -59,24 +59,24 @@ now support the primitives necessary for containerization, including
Linux with [openvz](http://openvz.org), Linux with [openvz](http://openvz.org),
[vserver](http://linux-vserver.org) and more recently [vserver](http://linux-vserver.org) and more recently
[lxc](http://lxc.sourceforge.net), Solaris with [lxc](http://lxc.sourceforge.net), Solaris with
[zones](http://docs.oracle.com/cd/E26502_01/html/E29024/preface-1.html#scrolltoc) [zones](http://docs.oracle.com/cd/E26502_01/html/E29024/preface-1.html#scrolltoc),
and FreeBSD with and FreeBSD with
[Jails](http://www.freebsd.org/doc/handbook/jails.html). [Jails](http://www.freebsd.org/doc/handbook/jails.html).
Docker builds on top of these low-level primitives to offer developers a Docker builds on top of these low-level primitives to offer developers a
portable format and runtime environment that solves all 4 problems. portable format and runtime environment that solves all four problems.
Docker containers are small (and their transfer can be optimized with Docker containers are small (and their transfer can be optimized with
layers), they have basically zero memory and cpu overhead, they are layers), they have basically zero memory and cpu overhead, they are
completely portable and are designed from the ground up with an completely portable, and are designed from the ground up with an
application-centric design. application-centric design.
The best part: because Docker operates at the OS level, it can still be Perhaps best of all, because Docker operates at the OS level, it can still be
run inside a VM! run inside a VM!
## Plays well with others ## Plays well with others
Docker does not require that you buy into a particular programming Docker does not require you to buy into a particular programming
language, framework, packaging system or configuration language. language, framework, packaging system, or configuration language.
Is your application a Unix process? Does it use files, tcp connections, Is your application a Unix process? Does it use files, tcp connections,
environment variables, standard Unix streams and command-line arguments environment variables, standard Unix streams and command-line arguments
@ -112,9 +112,9 @@ This is usually difficult for several reasons:
of them handle it differently. of them handle it differently.
Docker solves dependency hell by giving the developer a simple way to Docker solves the problem of dependency hell by giving the developer a simple
express *all* their application's dependencies in one place, and way to express *all* their application's dependencies in one place, while
streamline the process of assembling them. If this makes you think of streamlining the process of assembling them. If this makes you think of
[XKCD 927](http://xkcd.com/927/), don't worry. Docker doesn't [XKCD 927](http://xkcd.com/927/), don't worry. Docker doesn't
*replace* your favorite packaging systems. It simply orchestrates *replace* your favorite packaging systems. It simply orchestrates
their use in a simple and repeatable way. How does it do that? With their use in a simple and repeatable way. How does it do that? With
@ -180,12 +180,12 @@ Contributing to Docker
[![GoDoc](https://godoc.org/github.com/docker/docker?status.png)](https://godoc.org/github.com/docker/docker) [![GoDoc](https://godoc.org/github.com/docker/docker?status.png)](https://godoc.org/github.com/docker/docker)
[![Jenkins Build Status](https://jenkins.dockerproject.com/job/Docker%20Master/badge/icon)](https://jenkins.dockerproject.com/job/Docker%20Master/) [![Jenkins Build Status](https://jenkins.dockerproject.com/job/Docker%20Master/badge/icon)](https://jenkins.dockerproject.com/job/Docker%20Master/)
Want to hack on Docker? Awesome! There are instructions to get you Want to hack on Docker? Awesome! We have [instructions to help you get
started [here](CONTRIBUTING.md). If you'd like to contribute to the started](CONTRIBUTING.md). If you'd like to contribute to the
documentation, please take a look at this [README.md](https://github.com/docker/docker/blob/master/docs/README.md). documentation, please take a look at this [README.md](https://github.com/docker/docker/blob/master/docs/README.md).
These instructions are probably not perfect, please let us know if anything These instructions are probably not perfect, please let us know if anything
feels wrong or incomplete. feels wrong or incomplete. Better yet, submit a PR and improve them yourself.
Want to run Docker from a master build? You can download Want to run Docker from a master build? You can download
master builds at [master.dockerproject.com](https://master.dockerproject.com). master builds at [master.dockerproject.com](https://master.dockerproject.com).
@ -194,7 +194,7 @@ They are updated with each commit merged into the master branch.
### Legal ### Legal
*Brought to you courtesy of our legal counsel. For more context, *Brought to you courtesy of our legal counsel. For more context,
please see the Notice document.* please see the "NOTICE" document in this repo.*
Use and transfer of Docker may be subject to certain restrictions by the Use and transfer of Docker may be subject to certain restrictions by the
United States and other governments. United States and other governments.
@ -212,10 +212,12 @@ license text.
Other Docker Related Projects Other Docker Related Projects
============================= =============================
There are a number of projects under development that are based on Docker's There are a number of projects under development that are based on Docker's
core technology. These projects expand the tooling built around the core technology. These projects expand the tooling built around the
Docker platform to broaden its application and utility. Docker platform to broaden its application and utility.
If you know of another project underway that should be listed here, please help
us keep this list up-to-date by submitting a PR.
* [Docker Registry](https://github.com/docker/docker-registry): Registry * [Docker Registry](https://github.com/docker/docker-registry): Registry
server for Docker (hosting/delivering of repositories and images) server for Docker (hosting/delivering of repositories and images)