Skip to content
This repository has been archived by the owner on Sep 26, 2020. It is now read-only.

Commit

Permalink
Update README.md with current compatibility info
Browse files Browse the repository at this point in the history
Update the XHGUI range to include 0.8 and 0.9 to clarify that
there still have not been backwards-incompatible schema changes.

Keep using explicit version number for XHGUI because may break
compatibility in a 0.x release.

Also update the collector version start explicitly at 1.0.0 to indicate that as of writing all
versions have been cross-compatible. Keep the collector's range as `1.x` instead of
explicit because it is not expected for a future `1.x` release to break compatibility.

Fixes #9.
  • Loading branch information
Krinkle authored May 9, 2018
1 parent fff0f29 commit c7512c7
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ This project was originally forked from [perftools/xhgui@133051f], which was aft

This should ensure compatibility for most tags up to 0.7.1 (included).

The only thing to break compatibility would be a schema change on XHGUI side.
The only change that would break compatibility would be a schema change on the XHGUI side.

This table represents current known information about compatibility between this project and [XHGUI][2] data schema.

| XHGUI Collector version | XHGUI Version | Compatibility |
|-------------------------|---------------|------------------------------------------|
| 1.x | 0.2.0 - 0.7.1 | presumed compatible - schema is the same |
| XHGUI Collector version | XHGUI Version | Compatibility |
|-------------------------|---------------|-----------------------------------------|
| 1.0.0 - 1.x | 0.2.0 - 0.9.0 | presumed compatible - no schema changes |

## Usage

Expand Down

0 comments on commit c7512c7

Please sign in to comment.