Skip to content

Commit f9c9db1

Browse files
authored
Update README.md
1 parent 161ed22 commit f9c9db1

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,16 +75,20 @@ var clone = FastCloner.FastCloner.ShallowClone(new { Hello = "world", MyList = n
7575

7676
FastCloner uses caching by default, which makes evaluating properties harder. Cloning unmanaged resources, such as `IntPtr`s may result in side-effects, as there is no metadata for the length of buffers such pointers often point to. `ReadOnly` and `Immutable` collections are tested to behave well if they follow basic conventions. Many other features, such as cloning `Dictionary`ies properly while keeping hashcodes, `INotifyPropertyChanged`, `delegate`s, `event`s, `HttpRequest`s / responses, and others are supported. If something doesn't work out of the box, let me know in the [issues](https://github.com/lofcz/FastCloner/issues), the repository is actively maintained.
7777

78-
Cache can be invalidated to reduce memory footprint, if needed:
78+
Cache can be invalidated to reduce the memory footprint, if needed:
7979

8080
```csharp
8181
FastCloner.FastCloner.ClearCache();
8282
```
8383

8484
## Performance
8585

86-
FastCloner aims to _work correctly_ and meet reasonable expectations by default while being fast. Benchmarking results are available [here](https://github.com/lofcz/FastCloner/tree/next/FastCloner.Benchmark), check them out! By default, fast cloner relies on heavily cached reflection to work. An incremental source generator is currently in development as an opt-in alternative for performance-critical scenarios.
86+
FastCloner aims to _work correctly_ and meet reasonable expectations by default while being fast. Benchmarking results are available [here](https://github.com/lofcz/FastCloner/tree/next/FastCloner.Benchmark), check them out! By default, FastCloner relies on heavily cached reflection to work. An incremental source generator is currently in development as an opt-in alternative for performance-critical scenarios.
87+
88+
## Contributing
89+
90+
If you are looking to add new functionality, please open an issue first to verify your intent is aligned with the scope of the project. The library is covered by [~300 tests](https://github.com/lofcz/FastCloner/tree/next/FastCloner.Tests), please run them against your work before proposing changes. When reporting issues, providing a minimal reproduction we can plug in as a new test greatly reduces turnaround time.
8791

8892
## License
8993

90-
[MIT](https://github.com/lofcz/FastCloner/blob/next/LICENSE), simple 💜
94+
This library is licensed under the [MIT](https://github.com/lofcz/FastCloner/blob/next/LICENSE) license. 💜

0 commit comments

Comments
 (0)