Skip to content

Commit

Permalink
Update the requirements in the readme
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Smith <tsmith@chef.io>
  • Loading branch information
tas50 committed Jun 3, 2021
1 parent d7211ee commit 1a1493a
Showing 1 changed file with 6 additions and 15 deletions.
21 changes: 6 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.
```
```

0 comments on commit 1a1493a

Please sign in to comment.