From 1a1493ae604ecafb6b511a09e47adce7f7dab3b5 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Wed, 2 Jun 2021 17:24:26 -0700 Subject: [PATCH] Update the requirements in the readme Signed-off-by: Tim Smith --- README.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d01f57a..62cbead 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,11 @@ ## Overview -This is the official Chef [Knife](http://docs.chef.io/knife.html) plugin for -[Google Compute Engine](https://cloud.google.com/products/compute-engine). -This plugin gives knife the ability to create, bootstrap, and manage -Google Compute Engine (GCE) instances. +This is the official Chef [Knife](http://docs.chef.io/knife.html) plugin for [Google Compute Engine](https://cloud.google.com/products/compute-engine). This plugin gives knife the ability to create, bootstrap, and manage Google Compute Engine (GCE) instances. ## Compatibility -This plugin has been tested with Chef 12.x and uses the [Google API Ruby Client](https://github.com/google/google-api-ruby-client). +This plugin has been tested with Chef 17 and uses the [Google API Ruby Client](https://github.com/google/google-api-ruby-client). # Getting Started @@ -32,12 +29,6 @@ Install the gem with: gem install knife-google ``` -Or, even better, if you're using the ChefDK: - -```sh -chef gem install knife-google -``` - If you're using Bundler, simply add it to your Gemfile: ```ruby @@ -70,7 +61,7 @@ The easiest way to create this is to download and install the [Google Cloud SDK] If you already have a file you'd like to use that is in a different location, set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable with the full path to that file. -## Configuration +## Configuration All knife-google commands require a project name, and most commands require zone name to be supplied. You can supply these on the command line: @@ -284,7 +275,7 @@ WinRM is used by Chef to bootstrap Windows nodes. The default settings of the GC All documentation is written using YARD. You can generate a by running: ``` -rake docs +yard ``` ## Contributing @@ -295,7 +286,7 @@ For information on contributing to this project please see our [Contributing Doc Version 3.0.0 of knife-google was rewritten by Chef Partner Engineering but is largely inspired by initial versions of knife-google, thanks to the work of the great folks at Google. -- Copyright:: Copyright (c) 2016-2018 Chef Software, Inc. +- Copyright:: Chef Software, Inc. - License:: Apache License, Version 2.0 ```text @@ -310,4 +301,4 @@ 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. -``` \ No newline at end of file +```