Skip to content

Commit 0b64056

Browse files
authored
Merge pull request #1868 from lukpueh/minor-doc-updates
doc: minor updates in readme and reference docs
2 parents 7dc057a + 7a13933 commit 0b64056

File tree

2 files changed

+10
-14
lines changed

2 files changed

+10
-14
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,12 @@ page for more details about the release and the deprecation of the legacy
1414
implementation, including migration instructions.*
1515

1616
----------------------------
17-
This repository is the **reference implementation** of
18-
[The Update Framework (TUF)](https://theupdateframework.github.io/).
19-
It is written in Python and intended to conform to version 1.0 of the
20-
[TUF specification](https://theupdateframework.github.io/specification/latest/).
17+
[The Update Framework (TUF)](https://theupdateframework.io/) is a framework for
18+
secure content delivery and updates. It protects against various types of
19+
supply chain attacks and provides resilience to compromise. This repository is a
20+
**reference implementation** written in Python. It is intended to conform to
21+
version 1.0 of the [TUF
22+
specification](https://theupdateframework.github.io/specification/latest/).
2123

2224
Python-TUF provides two APIs:
2325
* [`tuf.api.metadata`](https://theupdateframework.readthedocs.io/en/latest/api/tuf.api.html),
@@ -69,10 +71,10 @@ for the reference implementation
6971

7072
Contact
7173
-------
72-
Please contact us via our [mailing
73-
list](https://groups.google.com/forum/?fromgroups#!forum/theupdateframework).
74-
Questions, feedback, and suggestions are welcomed on this low volume mailing
75-
list.
74+
Questions, feedback, and suggestions are welcomed on our low volume [mailing
75+
list](https://groups.google.com/forum/?fromgroups#!forum/theupdateframework) or
76+
the [#tuf](https://cloud-native.slack.com/archives/C8NMD3QJ3) channel on [CNCF
77+
Slack](https://slack.cncf.io/).
7678

7779
We strive to make the specification easy to implement, so if you come across
7880
any inconsistencies or experience any difficulty, do let us know by sending an

docs/api/api-reference.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,6 @@ Code `examples <https://github.com/theupdateframework/python-tuf/tree/develop/ex
2222
are available for client implementation using ngclient and a
2323
basic repository using Metadata API.
2424

25-
.. note:: Major API changes are unlikely but these APIs are not yet
26-
considered stable, and a higher-level repository operations API is not yet
27-
included.
28-
29-
There is a legacy implementation in the source code (not covered by this
30-
documentation): it is in maintenance mode and receives no feature work.
3125

3226
.. toctree::
3327
:maxdepth: 2

0 commit comments

Comments
 (0)