Skip to content

Commit 8ef9762

Browse files
authored
docs: Update readme to reflect alpha status. (#134)
Signed-off-by: Chris Butler <chris@thebutlers.me>
1 parent 3e00d5d commit 8ef9762

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ Trestle aims to reduce or remove this barrier by bringing the maintenance of con
1616

1717
Trestle implicitly provides a core opinionated workflow driven by its pipeline steps to allow standardized interlocks with other compliance tooling platforms.
1818

19+
## Development status
20+
21+
Compliance trestle is currently alpha. The expectation is that throughout the remainder of 2020 there may be unnannounced changes that are breaking within the trestle codebase. If you are using trestle please contact us so we are aware your usecase.
22+
23+
The underlying OSCAL schema is also currently changing. The current approach until the formal release of OSCAL 1.0.0 is for compliance trestle to regularly update our models to reflect NIST's changes.
24+
1925
### Machine readable compliance format
2026

2127
Compliance activities at scale, whether size of estate or number of accreditations, require automation to be successful and repeatable. OSCAL as a standard allows teams to bridge between the "Governance" layer and operational tools.
@@ -30,7 +36,7 @@ Trestle converts complex schema/data structures into simple files in a directory
3036

3137
Install from PYPI and run:
3238

33-
~~~shell
39+
```shell
3440
# Setup virtual environement
3541
python3 -m venv venv
3642
. ./venv/bin/activate
@@ -40,11 +46,11 @@ pip install compliance-trestle
4046

4147
# Run Trestle CLI
4248
trestle -h # For command line help
43-
~~~
49+
```
4450

4551
In order to install Trestle from source, run the following command:
4652

47-
~~~shell
53+
```shell
4854
# Clone
4955
git clone https://github.com/IBM/compliance-trestle.git
5056
cd compliance-trestle
@@ -56,7 +62,7 @@ pip install -q -e ".[dev]" --upgrade --upgrade-strategy eager
5662

5763
# Run Trestle CLI
5864
trestle -h
59-
~~~
65+
```
6066

6167
## Supported OSCAL elements and extensions
6268

@@ -81,7 +87,7 @@ Our project welcomes external contributions. Please consult [CONTRIBUTING.md](<C
8187
If you would like to see the detailed LICENSE click [here](<LICENSE>).
8288
Consult [MAINTAINERS](<MAINTAINERS.md>) for a list of authors.
8389

84-
~~~text
90+
```text
8591
# Copyright (c) 2020 IBM Corp. All rights reserved.
8692
#
8793
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -96,4 +102,4 @@ Consult [MAINTAINERS](<MAINTAINERS.md>) for a list of authors.
96102
# See the License for the specific language governing permissions and
97103
# limitations under the License.
98104
99-
~~~
105+
```

0 commit comments

Comments
 (0)