Skip to content

Commit d17cd76

Browse files
adding caveats section
1 parent 5522c8c commit d17cd76

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,15 @@ struct AuthorBasicRights: RightsManifest {
218218
}
219219
```
220220

221+
### Caveats
222+
223+
This is not a perfect protection for no one to be able to access things they shouldn't.
224+
Protected is not a security framework, it will not prevent people from accessing or mutating anything.
225+
It is intended as an easy way to make safe usage clear and simple depending on context.
226+
227+
1. A code can always access everything using the `unsafeX` methods provided.
228+
2. You can (but really shouldn't) include more rights whithin the extension of a manifest. This allows you to include more rights than intended while still appearing to be safe. Do not do this! Protected cannot protect you from doing this.
229+
221230
## Contributions
222231
Contributions are welcome and encouraged!
223232

0 commit comments

Comments
 (0)