Skip to content

Commit b5fcda3

Browse files
docs: general updates
1 parent b3099a8 commit b5fcda3

File tree

4 files changed

+10
-59
lines changed

4 files changed

+10
-59
lines changed

README.md

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
11
<p align="center">
2-
<img src="logo.svg" width="50%" />
2+
<img src="logo.png" width="90%" />
33
</p>
44

55
## Overview
66

77
- Typesafe, with helpful type inference
88
- Expressive API
99
- Supports predicates and not patterns for complex cases
10-
- Tiny bundle footprint (`~7.4 kB`)
10+
- Tiny bundle footprint
11+
12+
<p align="center">
13+
<img src="hero.png" />
14+
</p>
15+
16+
## Documentation
17+
18+
Visit the [official website](https://react-matchez.netlify.app) to view the full documentation.
1119

1220
## Status
1321

@@ -18,28 +26,3 @@ breaking changes here as I figure out how to:
1826
- improve the overall type-safety
1927
- simplify its API
2028
- reduce its bundle size
21-
22-
## Documentation
23-
24-
- [Overview](#overview)
25-
- [Status](#status)
26-
- [Documentation](#documentation)
27-
- [Inspirations](#inspirations)
28-
29-
## Inspirations
30-
31-
This library has been heavily inspired by:
32-
33-
- [ts-pattern](https://github.com/gvergnaud/ts-pattern): A great library by
34-
[Gabriel Vergnaud](https://github.com/gvergnaud) that not only inspired the
35-
core and the APIs of `react-matchez` but is also used by our internals.
36-
37-
- [Daggy](https://github.com/fantasyland/daggy): A great library from the
38-
[Fantasy Land](https://github.com/fantasyland) universe that brings sum types
39-
to JavaScript. Using its `taggedSum` and `cata` methods, you can get really a
40-
really interesting taste of pattern matching.
41-
42-
- [ECMAScript pattern matching proposal](https://github.com/tc39/proposal-pattern-matching):
43-
This proposal briefly covers what the JSX syntax would look like. Even though
44-
`react-matchez` didn't quite use it as an inspiration, it was still an
45-
interesting reference.

hero.png

308 KB
Loading

logo.png

156 KB
Loading

logo.svg

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)