README.md in hyperkit-1.0.0 vs README.md in hyperkit-1.0.2
- old
+ new
@@ -1,7 +1,9 @@
# Hyperkit
+[](https://badge.fury.io/rb/hyperkit) [](http://rubydoc.info/github/jeffshantz/hyperkit/master) [](https://travis-ci.org/jeffshantz/hyperkit) [](https://coveralls.io/github/jeffshantz/hyperkit?branch=master)
+
Hyperkit is a flat API wrapper for LXD, the next-generation hypervisor. It is
shamelessly based on the design of Octokit, the popular wrapper for the GitHub
API.
## Installation
@@ -49,21 +51,21 @@
# Migrate a container (or a snapshot) from one server to another
# Note that CRIU must be installed on both LXD servers to migrate a running
# container.
lxd2 = Hyperkit::Client.new(api_endpoint: "https://lxd2.example.com")
source = lxd2.init_migration("remote-container")
-lxd.migrate_container(source, "migrated-container")
+lxd.migrate(source, "migrated-container")
```
Each method in the API documentation has at least one example of its usage. Please see the documentation for the following modules:
-* [Certificates]()
-* [Containers]()
-* [Images]()
-* [Networks]()
-* [Operations]()
-* [Profiles]()
+* [Certificates](http://www.rubydoc.info/github/jeffshantz/hyperkit/master/Hyperkit/Client/Certificates)
+* [Containers](http://www.rubydoc.info/github/jeffshantz/hyperkit/master/Hyperkit/Client/Containers)
+* [Images](http://www.rubydoc.info/github/jeffshantz/hyperkit/master/Hyperkit/Client/Images)
+* [Networks](http://www.rubydoc.info/github/jeffshantz/hyperkit/master/Hyperkit/Client/Networks)
+* [Operations](http://www.rubydoc.info/github/jeffshantz/hyperkit/master/Hyperkit/Client/Operations)
+* [Profiles](http://www.rubydoc.info/github/jeffshantz/hyperkit/master/Hyperkit/Client/Profiles)
## Requirements
Hyperkit supports **LXD 2.0.0 and above**, and **Ruby 2.0 and above**.
@@ -96,11 +98,11 @@
# Create an Ubuntu 14.04 container
client.create_container("test-container", alias: "ubuntu/trusty/amd64")
```
-[API methods]: http://TODO
+[API methods]: http://www.rubydoc.info/list/github/jeffshantz/hyperkit/master/method
## Authentication
The LXD API uses client-side certificates to authenticate clients. By
default, Hyperkit uses the following files:
@@ -158,17 +160,17 @@
Alternatively, you can simply copy your certificate file to the LXD server and
use the `lxc` tool to trust it:
```
-lxd-server$ lxc config trust add my-new-cert.crt
+$ lxc config trust add my-new-cert.crt
```
## API coverage
Hyperkit supports the entirety of [version 1.0 of the LXD
-API](https://github.com/lxc/lxd/blob/master/specs/rest-api.md), but does not
+API](https://github.com/lxc/lxd/blob/master/doc/rest-api.md), but does not
support any of the Websocket API calls (e.g. `/1.0/events`).
## Asynchronous Operations
A good deal of the LXD API calls are asynchronous: you issue the call, and you
@@ -293,9 +295,11 @@
volunteer to be a maintainer. Being a maintainer entails making sure all tests
run and pass on that implementation. When something breaks on your
implementation, you will be responsible for providing patches in a timely
fashion. If critical issues for a particular implementation exist at the time
of a major release, support for that Ruby version may be dropped.
+
+[travis]: https://travis-ci.org/jeffshantz/hyperkit
## Versioning
This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
of this scheme should be reported as bugs. Specifically, if a minor or patch