Update README to be a bit more clear

Also link to placement docs for some context.

Change-Id: I5d0603cd5587d08f8c1d9ef91fbd73069ff57f59
Story: 2005170
Task: 29911
This commit is contained in:
Chris Dent 2019-09-10 13:09:32 +01:00
parent 5a477b8aed
commit 6bb08072cb

View File

@ -2,15 +2,17 @@
os-traits
=========
`os-traits` is a library containing standardized trait strings.
`os-traits` is an OpenStack library containing standardized trait strings.
Traits are strings that represent a feature of some resource provider. This
library contains the catalog of constants that have been standardized in the
OpenStack community to refer to a particular hardware, virtualization, storage,
network, or device trait.
Traits are strings that represent a feature of a resource provider hosted by
the Placement_ service. This library contains the catalog of constants that
have been standardized in the OpenStack community to refer to a particular
hardware, virtualization, storage, network, or device trait.
* Free software: Apache license
* Documentation: https://docs.openstack.org/os-traits/latest/
* Source: http://opendev.org/openstack/os-traits
* Bugs: https://storyboard.openstack.org/#!/project/openstack/os-traits
* Release Notes: https://docs.openstack.org/releasenotes/os-traits
.. _Placement: https://docs.openstack.org/placement/latest/