Skip to content

Commit c56d0dd

Browse files
Reword examples parent README with disclaimer (#445)
### Motivation As we approach 1.0, we want more examples of how to use this package and integrate with other packages in the ecosystem. However, these are deliberately meant to be illustrative, and are often deliberately not fully-featured. The README currently suggests using these as starter projects, which implies something stronger. ### Modifications Reword examples parent README with disclaimer ### Result Docs clearer. ### Test Plan None.
1 parent be0d91b commit c56d0dd

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

Examples/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Examples of using Swift OpenAPI Generator
22

3-
All the examples are self-contained, so you can copy the package directory of your chosen example and use it as a starter template for your project.
3+
This directory contains examples of how to use Swift OpenAPI Generator and
4+
integrate with other packages in the ecosystem.
5+
6+
> **Disclaimer:** Many of these examples have been deliberately simplified and are
7+
> intended for illustrative purposes only.
48
59
## Getting started
610

0 commit comments

Comments
 (0)