Skip to content

Commit

Permalink
1. Minor documentation fixes
Browse files Browse the repository at this point in the history
2. Update README
  • Loading branch information
denisandroid committed May 18, 2024
1 parent 132e943 commit cd35b0d
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 8 deletions.
14 changes: 14 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# http://editorconfig.org

root = true

[*.rs]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = false
indent_style = tab
indent_size = 5
max_line_length = 80
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@
</div>
</div>

## !!! ATTENTION !!!
## !!! ATTENTION

1. When converting types without checking the size of the data, you really need to understand what you are doing.
2. You must understand the specifics of the platform you are using.

## Library features:
## Library features

1. Casting any type A to any type B with generic data without and with data dimension checking.
2. Ability to use transmutation in constant functions in very old versions of rust.
3. Possibility of delayed transmutation through contracts.
4. Ability to work without the standard library.

## Usage:
## Usage

Add this to your Cargo.toml:

Expand All @@ -54,7 +54,8 @@ and this to your source code:
use cluFullTransmute::mem::transmute;
```

## Example:
## Example

```rust
use cluFullTransmute::transmute_or_panic;
use core::fmt::Display;
Expand Down Expand Up @@ -110,7 +111,8 @@ fn main() {
See all
</a>

## License:
## License

This project has a single license (LICENSE-APACHE-2.0).

<div align="left">
Expand All @@ -123,7 +125,8 @@ This project has a single license (LICENSE-APACHE-2.0).
</br></br></br>
</div>

### Apache License:
### Apache License

<div align="left">
<a href="./LICENSE">
<img align="left" src="https://github.com/UlinProject/img/blob/main/block_220_100/apache2.png?raw=true" alt="apache2"/>
Expand Down
1 change: 0 additions & 1 deletion examples/contract.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ use cluFullTransmute::contract::Contract;
situations where it can't be proven.
*/

///
struct MyData {
data: Contract<&'static str, &'static [u8]>,
}
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ A more complete and extended version of data type conversion without constraint
1. When converting types without checking the size of the data, you really need to understand what you are doing.
2. You must understand the specifics of the platform you are using.
## Example:
## Example
```rust
use cluFullTransmute::transmute_or_panic;
Expand Down

0 comments on commit cd35b0d

Please sign in to comment.