Skip to content
This repository was archived by the owner on Jun 29, 2023. It is now read-only.

Commit 0b2ebb1

Browse files
authored
Adjust readme (#7)
* Delete unused v3 schema - we didn't end up going this route * Correct link to v2 schema * Add rubygems badge * Add link to ERB
1 parent 1f8684b commit 0b2ebb1

File tree

2 files changed

+8
-262
lines changed

2 files changed

+8
-262
lines changed

README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![Gem Version](https://badge.fury.io/rb/kube_deploy_tools.svg)](https://badge.fury.io/rb/kube_deploy_tools)
2+
13
# kube_deploy_tools (kdt)
24

35
`kube_deploy_tools` (kdt) is a tool to simplify kubernetes manifest generation
@@ -28,6 +30,7 @@ a complete production lifecycle, they are also designed to be used
2830
individually.
2931

3032
[Helm]: https://helm.sh
33+
[ERB]: https://ruby-doc.org/stdlib-2.7.1/libdoc/erb/rdoc/ERB.html
3134

3235
# Getting Started
3336

@@ -103,7 +106,7 @@ To explore further,
103106
* Run `kdt deploy -f build/kubernetes/prod_default --context my-kube-context` to send your generated
104107
manifests to a Kubernetes API server.
105108

106-
[complete description]: XXX
109+
[complete description]: schemas/v2.schema.json
107110

108111
# FAQ
109112

@@ -118,19 +121,6 @@ For breaking changes, new features, and new fixes, see
118121

119122
# Contribute
120123

121-
```bash
122-
# Install ruby w/ Homebrew
123-
brew install ruby
124-
125-
# Or install ruby w/ rbenv
126-
brew install rbenv ruby-build
127-
rbenv install 2.3.0
128-
rbenv global 2.3.0
129-
130-
# Install gem
131-
gem install bundler
132-
```
133-
134124
```bash
135125
bundle install --with development
136126
@@ -140,3 +130,7 @@ bundle exec rake test
140130
# Exec a binary in bin/
141131
bundle exec kdt generate
142132
```
133+
134+
We accept [pull requests]. They will be reviewed by a member of the LiveRamp development team as soon as possible.
135+
136+
[pull requests]: https://github.com/LiveRamp/kube_deploy_tools/pulls

schemas/v3.schema.json

Lines changed: 0 additions & 248 deletions
This file was deleted.

0 commit comments

Comments
 (0)