Skip to content

Commit 0995942

Browse files
Update readme and the changelog
1 parent 26d1f8d commit 0995942

File tree

2 files changed

+24
-6
lines changed

2 files changed

+24
-6
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Changelog
22

3-
# v3.0 (WIP)
3+
# v3.0
44

5-
Whta's new in version 3.0:
5+
Whats's new in version 3.0:
66

77
- Changed the .NET Standard version to 2.1
88
- Added support for nullable reference types

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,14 @@ Version 1.x can be found there. This repository contains version 2+.
1111

1212
## Installation
1313

14+
If your platform supports .NET Standard, you can install the latest version:
15+
16+
```
17+
Install-Package Matchmaker -Version 3.0.0
18+
```
19+
20+
If it doesn't, then stick to versions 2.x:
21+
1422
```
1523
Install-Package Matchmaker -Version 2.1.0
1624
```
@@ -101,23 +109,33 @@ you can think about.
101109
## More Info
102110

103111
If you want to learn how to use this library, you should read the
104-
[documentation](https://tolikpylypchuk.github.io/Matchmaker/v2.1.0). The articles provide everything you need to know
112+
[documentation](https://tolikpylypchuk.github.io/Matchmaker/v3.0.0). The articles provide everything you need to know
105113
to use this library.
106114

107115
If you need extensive information, go to the
108-
[API reference](https://tolikpylypchuk.github.io/Matchmaker/v2.1.0/api/index.html).
116+
[API reference](https://tolikpylypchuk.github.io/Matchmaker/v3.0.0/api/index.html).
109117

110118
If you need even more info about this library, you can go through the
111-
[tests](https://github.com/TolikPylypchuk/Matchmaker/tree/v2.1.0/Matchmaker.Tests). They are property-based and as such
119+
[tests](https://github.com/TolikPylypchuk/Matchmaker/tree/v3.0.0/Matchmaker.Tests). They are property-based and as such
112120
they describe every aspect of the classes and their members.
113121

114122
The documentation can be found here:
115123

116-
- Version 3.0.0 (WIP): https://tolikpylypchuk.github.io/Matchmaker/v3.0.0
124+
- Version 3.0.0: https://tolikpylypchuk.github.io/Matchmaker/v3.0.0
117125
- Version 2.1.0: https://tolikpylypchuk.github.io/Matchmaker/v2.1.0
118126
- Version 2.0.0: https://tolikpylypchuk.github.io/Matchmaker/v2.0.0
119127
- Older versions: https://github.com/TolikPylypchuk/PatternMatching
120128

129+
## Is This Library Still Maintained?
130+
131+
I'm not planning on writing new versions beyond 3.0 (or maybe 3.1 if some stuff needs fixing). To be fair, I thought
132+
the same thing after releasing version 1.1 and yet here we are. This time I do believe that this library has enough
133+
features (probably more than enough). Maybe one day I'll revisit this decision, but for now (May 2020) this is it;
134+
this is as good as it gets.
135+
136+
That said, if you report a bug or request a new feature, I'll definitely look into it. I'm not giving up on this
137+
library any time soon.
138+
121139
## License
122140

123141
[MIT License](https://github.com/TolikPylypchuk/Matchmaker/blob/master/LICENSE)

0 commit comments

Comments
 (0)