Skip to content

Commit 25f4fc5

Browse files
authored
Refactor README for clarity and updates
Removed redundant sections and added note about Linux compatibility.
1 parent 142843b commit 25f4fc5

1 file changed

Lines changed: 3 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@
44

55
This .NET Nuget package is a cryptographic wrapper library for developers that are seeking the memory safety of Rust for their crypto implementations.
66

7-
Ever wanted all of your most useful cryptographic operations in one module and not have to surf documentation for various packages?
8-
CAS is here to provide a unified development experience as an abstract layer to the RustCrypto and Dalek-Cryptography suite of algorithms.
9-
The official Nuget page can be found [here](https://www.nuget.org/packages/cas-dotnet-sdk).
7+
## [Sequential Examples / Benchmarks](./docs/EXAMPLES.md)
108

11-
**Note: All work is experimental and we understand some benchmarks might not be the most optimal.**
9+
The official Nuget page can be found [here](https://www.nuget.org/packages/cas-dotnet-sdk).
1210

1311
## Consuming Library Documentation
1412
This C# nuget package is dependent on our Rust layer that contains methods to run industry-standard cryptographic operations. [cas-lib](https://github.com/Cryptographic-API-Services/cas-lib).
@@ -18,16 +16,11 @@ We utilize some smart people's existing work and we believe their documentation
1816
- [Dalek-Cryptography](https://github.com/dalek-cryptography)
1917
- [Rust Crypto](https://github.com/RustCrypto)
2018

21-
## [Sequential Examples / Benchmarks](./docs/EXAMPLES.md)
22-
2319
## Supported Frameworks / Operating Systems
2420
We aim to provide cross-compatibility wherever possible.
2521
- [X] .NET 6
2622
- [X] .NET 7
2723
- [X] .NET 8
2824
- [X] .NET 9
2925
- [X] Windows x64
30-
- [X] Linux x64
31-
32-
## Disclaimer
33-
Many of the cryptographic crates that are utilized in our core FFI [layer](https://github.com/Crytographic-API-Services/cas-core-lib) have never had a security audit performed. Utilize this SDK at your own risk.
26+
- [X] Linux x64 (Ubuntu, if you are using Microsoft Docker images we recommend the noble images).

0 commit comments

Comments
 (0)