Skip to content

Commit 4584019

Browse files
authored
Update README.md
1 parent 844e795 commit 4584019

File tree

1 file changed

+5
-26
lines changed

1 file changed

+5
-26
lines changed

README.md

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,32 +14,11 @@ AngleSharp Diffing makes it possible to compare AngleSharp _control_ nodes and _
1414

1515
The _control_ nodes represents the expected HTML tree, i.e. how the nodes are expected to look, and the _test_ nodes represents the nodes that should be compared to the _control_ nodes.
1616

17-
See the [Wiki for documentation](https://github.com/AngleSharp/AngleSharp.Diffing/wiki) and more examples.
18-
19-
**Differences:** There are three types off `IDiff` differences, that the library can return.
20-
21-
- `NodeDiff`/`AttrDiff`: Represents a difference between a control and test node or a control and test attribute.
22-
- `MissingNodeDiff`/`MissingAttrDiff`: Represents a difference where a control node or control attribute was expected to exist, but was not found in the test nodes tree.
23-
- `UnexpectedNodeDiff`/`UnexpectedAttrDiff`: Represents a difference where a test node or test attribute was unexpectedly found in the test nodes tree, but did not have a match in the control nodes tree.
24-
25-
# Usage
26-
To find the differences between a control HTML fragment and a test HTML fragment, using the default options, the easiest way is to use the `DiffBuilder` class, like so:
27-
28-
```csharp
29-
var controlHtml = "<p>Hello World</p>";
30-
var testHtml = "<p>World, I say hello</p>";
31-
var diffs = DiffBuilder
32-
.Compare(control)
33-
.WithTest(test)
34-
.Build();
35-
```
36-
37-
Read more about the available options on the [Options](/docs/Options.md) page.
38-
39-
# Documentation
40-
- [Options](/docs/Options.md)
41-
- [Creating custom diffing options](/docs/CustomOptions.md)
42-
- [Difference engine internals](/docs/DiffingEngineInternals.md)
17+
### Documentation:
18+
- [Getting started](https://github.com/AngleSharp/AngleSharp.Diffing/wiki/Getting-Started)
19+
- [Diffing options](https://github.com/AngleSharp/AngleSharp.Diffing/wiki/Diffing-Options)
20+
- [Creating custom diffing strategies](https://github.com/AngleSharp/AngleSharp.Diffing/wiki/Getting-Started)
21+
- [Difference Engine Internals](https://github.com/AngleSharp/AngleSharp.Diffing/wiki/Difference-Engine-Internals)
4322

4423
## Acknowledgments
4524
- [Florian Rappl](https://github.com/FlorianRappl) from the AngleSharp team for providing ideas, input and sample code for working with AngleSharp.

0 commit comments

Comments
 (0)