linkerd
/
linkerd2
mirror of https://github.com/linkerd/linkerd2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

updates to README linking to docs and getting started (#39) 

* updates to README linking to docs and getting started

* minor line break revisions

* markdown revisions and simplification

* updating line breaks and errant spaces

* updates grammar and simplifies language
This commit is contained in:
Sterling White 2017-12-13 16:39:49 -08:00 committed by GitHub
parent 6b00bb8283
commit c26e7f39a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -12,15 +12,39 @@ all the heartbleed.
Conduit is **experimental**. Currently, it _only supports HTTP/2_ and is especially
well-suited for [gRPC][grpc]. Follow our progress towards production-readiness here and on
[twitter][twitter].
[Twitter][twitter].
<!-- TODO add roadmap link -->
## Documentation
View [Conduit docs][conduit-docs] for more a more comprehensive guide to
getting started.
## Getting started with Conduit
1. Install the Conduit CLI `curl https://run.conduit.io/install | sh `
2. Copy `/Users/username/.conduit/bin/conduit` into your PATH
3. Run `conduit install | kubectl apply -f -` to install Conduit
4. Check to make sure you're running the [latest version][releases]of Conduit
with `conduit version`
5. Open a local version of the Conduit controller with `conduit dashboard`
6. (Optional) To install a demo application for your Conduit instance, visit
[this section on Conduit docs][conduit-demo]
## Code of Conduct
This project is for everyone. We ask that our users and contributors take a few
minutes to review our [code of conduct][coc].
## License
Copyright 2017, Buoyant Inc. All rights reserved.
@ -40,12 +64,14 @@ specific language governing permissions and limitations under the License.
[ci]: https://travis-ci.org/runconduit/conduit
[ci-badge]: https://travis-ci.org/runconduit/conduit.svg?branch=master
[coc]: https://github.com/linkerd/linkerd/wiki/Linkerd-code-of-conduct
[conduit-demo]: https://conduit.io/getting-started/#install-the-demo-app
[conduit-docs]: https://conduit.io/docs/
<!-- [examples]: https://github.com/runconduit/conduit-examples -->
[grpc]: https://grpc.io/
[l5d]: https://linkerd.io/
[license-badge]: https://img.shields.io/github/license/linkerd/linkerd.svg
[logo]: https://user-images.githubusercontent.com/240738/33589722-649152de-d92f-11e7-843a-b078ac889a39.png
<!-- [releases]: https://github.com/runconduit/conduit -->
[releases]: https://github.com/runconduit/conduit/releases
[rust]: https://rust-lang.org/
[twitter]: https://twitter.com/runconduit/
[slack-badge]: http://slack.linkerd.io/badge.svg