Skip to content

Commit d150ff4

Browse files
committed
Added a release section in the documentation
1 parent a0c5973 commit d150ff4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+723
-7
lines changed

docs/dist/_sources/index.rst.txt

+8-1
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,13 @@ The goal of this library is to make life of developers as easy as possible.
8686
twitter-client/events
8787
twitter-client/json
8888

89+
.. toctree::
90+
:maxdepth: 1
91+
:hidden:
92+
:caption: Releases
93+
94+
more/releases
95+
8996
.. toctree::
9097
:maxdepth: 1
9198
:hidden:
@@ -98,4 +105,4 @@ The goal of this library is to make life of developers as easy as possible.
98105
more/tweetinvi-container
99106
more/license
100107
more/help
101-
108+
+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Releases
2+
3+
## 5.0
4+
5+
Tweetinvi 5.0 is a major refactor of Tweetinvi. The new version introduces the `TwitterClient` which lets you perform all operations based on a fixed set of credentials. The change let us resolved various core problematics that arised with the evolution of the .NET Framework including async/await and ASP.NETCore execution contexts.
6+
7+
Here are some of the major changes.
8+
9+
* Async/Await
10+
11+
> Tweetinvi is now using the Async/Await pattern in its entire code base. This will help modern development and ease up ASPNET thread pool.
12+
13+
* [TwitterClient](https://linvi.github.io/tweetinvi/dist/intro/basic-concepts.html#twitterclient)
14+
15+
> The TwitterClient gives you better control over who is executing a request. Also it gives developers the ability to pass the client through the code.
16+
17+
* Twitter API V2
18+
19+
> Support of all the endpoints of Twitter API V2!
20+
21+
* [Parameters](https://linvi.github.io/tweetinvi/dist/intro/basic-concepts.html#parameters)
22+
23+
> Developers no longer have to search for endpoints available parameters. Tweetinvi contains all the parameters from the official documentation and all the parameters missing from the official documentation :D
24+
25+
* [Iterators](https://linvi.github.io/tweetinvi/dist/twitter-api/iterators.html)
26+
27+
> Iterators are a new way to use paging in Twitter in a single and unique way. Developers no longer need to understand the 4 types of paging from Twitter API, Tweetinvi takes care of it for you!
28+
29+
* [Brand new documentation](https://linvi.github.io/tweetinvi/dist/index.html)
30+
31+
> Tweetinvi documentation has been at the core of the new version.
32+
> * The new documentation should explain provide examples for all the bits and pieces you can find in the Tweetinvi library.
33+
> * All publicly available code has been annotated to explain what each method do and what they return.
34+
35+
* [Redesign of Account Activity](https://linvi.github.io/tweetinvi/dist/account-activity/account-activity.html)
36+
37+
> A lot of work has been done to simplify the Account Activity process and make it as easy as possible for developers to start using it.
38+
39+
* .NET Compatibility
40+
41+
> Tweetinvi 5.0 has been built for .NETStandard 1.4 and .NETStandard 2.0 which should make it compatible for most of the existing .NET environments!
42+
43+
* Support for missing endpoints
44+
45+
> Some endpoints were missing from the library. All endpoints in the Twitter documentation are now officially supported.
46+
47+
* [Redesign of Error Management](https://linvi.github.io/tweetinvi/dist/more/exceptions.html)
48+
49+
> Exceptions have never been a strong part of Tweetinvi. This has changed and Tweetinvi is now throwing a very limited set of Exceptions.
50+
51+
* Better support for special cases
52+
53+
> Twitter API endpoints are managing response formats, status codes, headers, response, error messages in different ways. Tweetinvi now takes care of all the special cases for you and handle these cases as you would expect hiding the complexity behind a simple API.
54+
55+
* Bug Fixes
56+
57+
> 5.0 was also a chance to fix a long list of bugs, including multithreading, missing data, unhandled cases, non matching criteria and many more...
58+
59+
* Integration Tests
60+
61+
> Tweetinvi 5.0 uses integration tests to verify that the code base is properly working. Not only does this give us a better view on the state of the library but also let you discover how to use the library!
62+
63+
* And much more
64+
65+
> Performance improvements, upload support, parameters validation, namespaces/code cleanup, dependencies updates, .NETCore support...
66+
67+
Tweetinvi 5.0 is the result of more than a year of work, countless hours and more than 350 commits so I hope you will appreciate using the new version.
68+
69+
I take this opportunity to thanks @JoshKeegan for his special contributions to the project.
70+
71+
I look forward to hearing your feedback!

docs/dist/account-activity/account-activity-events.html

+4
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,10 @@
145145
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
146146
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
147147
</ul>
148+
<p class="caption"><span class="caption-text">Releases</span></p>
149+
<ul>
150+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
151+
</ul>
148152
<p class="caption"><span class="caption-text">More</span></p>
149153
<ul>
150154
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/account-activity/account-activity-subscriptions.html

+4
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,10 @@
144144
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
145145
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
146146
</ul>
147+
<p class="caption"><span class="caption-text">Releases</span></p>
148+
<ul>
149+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
150+
</ul>
147151
<p class="caption"><span class="caption-text">More</span></p>
148152
<ul>
149153
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/account-activity/account-activity-with-aspnet.html

+4
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,10 @@
143143
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
144144
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
145145
</ul>
146+
<p class="caption"><span class="caption-text">Releases</span></p>
147+
<ul>
148+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
149+
</ul>
146150
<p class="caption"><span class="caption-text">More</span></p>
147151
<ul>
148152
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/account-activity/account-activity-with-http-server.html

+4
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,10 @@
140140
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
141141
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
142142
</ul>
143+
<p class="caption"><span class="caption-text">Releases</span></p>
144+
<ul>
145+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
146+
</ul>
143147
<p class="caption"><span class="caption-text">More</span></p>
144148
<ul>
145149
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/account-activity/account-activity.html

+4
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,10 @@
151151
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
152152
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
153153
</ul>
154+
<p class="caption"><span class="caption-text">Releases</span></p>
155+
<ul>
156+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
157+
</ul>
154158
<p class="caption"><span class="caption-text">More</span></p>
155159
<ul>
156160
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/authentication/authentication-pin-code.html

+4
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,10 @@
144144
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
145145
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
146146
</ul>
147+
<p class="caption"><span class="caption-text">Releases</span></p>
148+
<ul>
149+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
150+
</ul>
147151
<p class="caption"><span class="caption-text">More</span></p>
148152
<ul>
149153
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/authentication/authentication-url-redirect.html

+4
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,10 @@
145145
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
146146
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
147147
</ul>
148+
<p class="caption"><span class="caption-text">Releases</span></p>
149+
<ul>
150+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
151+
</ul>
148152
<p class="caption"><span class="caption-text">More</span></p>
149153
<ul>
150154
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/authentication/authentication.html

+4
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,10 @@
140140
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
141141
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
142142
</ul>
143+
<p class="caption"><span class="caption-text">Releases</span></p>
144+
<ul>
145+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
146+
</ul>
143147
<p class="caption"><span class="caption-text">More</span></p>
144148
<ul>
145149
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/credentials/credentials.html

+4
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,10 @@
147147
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
148148
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
149149
</ul>
150+
<p class="caption"><span class="caption-text">Releases</span></p>
151+
<ul>
152+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
153+
</ul>
150154
<p class="caption"><span class="caption-text">More</span></p>
151155
<ul>
152156
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/credentials/rate-limits-handlers.html

+4
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,10 @@
145145
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
146146
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
147147
</ul>
148+
<p class="caption"><span class="caption-text">Releases</span></p>
149+
<ul>
150+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
151+
</ul>
148152
<p class="caption"><span class="caption-text">More</span></p>
149153
<ul>
150154
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/credentials/rate-limits.html

+4
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,10 @@
147147
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
148148
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
149149
</ul>
150+
<p class="caption"><span class="caption-text">Releases</span></p>
151+
<ul>
152+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
153+
</ul>
150154
<p class="caption"><span class="caption-text">More</span></p>
151155
<ul>
152156
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/genindex.html

+4
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,10 @@
138138
<li class="toctree-l1"><a class="reference internal" href="twitter-client/events.html">Twitter Client - Events</a></li>
139139
<li class="toctree-l1"><a class="reference internal" href="twitter-client/json.html">Json - Serialize/Deserialize</a></li>
140140
</ul>
141+
<p class="caption"><span class="caption-text">Releases</span></p>
142+
<ul>
143+
<li class="toctree-l1"><a class="reference internal" href="more/releases.html">Releases</a></li>
144+
</ul>
141145
<p class="caption"><span class="caption-text">More</span></p>
142146
<ul>
143147
<li class="toctree-l1"><a class="reference internal" href="more/exceptions.html">Exceptions</a></li>

docs/dist/index.html

+6
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,10 @@
139139
<li class="toctree-l1"><a class="reference internal" href="twitter-client/events.html">Twitter Client - Events</a></li>
140140
<li class="toctree-l1"><a class="reference internal" href="twitter-client/json.html">Json - Serialize/Deserialize</a></li>
141141
</ul>
142+
<p class="caption"><span class="caption-text">Releases</span></p>
143+
<ul>
144+
<li class="toctree-l1"><a class="reference internal" href="more/releases.html">Releases</a></li>
145+
</ul>
142146
<p class="caption"><span class="caption-text">More</span></p>
143147
<ul>
144148
<li class="toctree-l1"><a class="reference internal" href="more/exceptions.html">Exceptions</a></li>
@@ -233,6 +237,8 @@ <h1>Tweetinvi 5.0<a class="headerlink" href="#tweetinvi-5-0" title="Permalink to
233237
</div>
234238
<div class="toctree-wrapper compound">
235239
</div>
240+
<div class="toctree-wrapper compound">
241+
</div>
236242
</div>
237243

238244

docs/dist/intro/basic-concepts.html

+4
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,10 @@
150150
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
151151
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
152152
</ul>
153+
<p class="caption"><span class="caption-text">Releases</span></p>
154+
<ul>
155+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
156+
</ul>
153157
<p class="caption"><span class="caption-text">More</span></p>
154158
<ul>
155159
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/intro/getting-started.html

+4
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,10 @@
146146
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
147147
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
148148
</ul>
149+
<p class="caption"><span class="caption-text">Releases</span></p>
150+
<ul>
151+
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
152+
</ul>
149153
<p class="caption"><span class="caption-text">More</span></p>
150154
<ul>
151155
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>

docs/dist/more/exceptions.html

+6-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
<link rel="index" title="Index" href="../genindex.html" />
4040
<link rel="search" title="Search" href="../search.html" />
4141
<link rel="next" title="Twitter Labs" href="twitter-labs.html" />
42-
<link rel="prev" title="Json - Serialize/Deserialize" href="../twitter-client/json.html" />
42+
<link rel="prev" title="Releases" href="releases.html" />
4343
</head>
4444

4545
<body class="wy-body-for-nav">
@@ -140,6 +140,10 @@
140140
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
141141
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
142142
</ul>
143+
<p class="caption"><span class="caption-text">Releases</span></p>
144+
<ul>
145+
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
146+
</ul>
143147
<p class="caption"><span class="caption-text">More</span></p>
144148
<ul class="current">
145149
<li class="toctree-l1 current"><a class="current reference internal" href="#">Exceptions</a><ul>
@@ -282,7 +286,7 @@ <h2>How to handle an exception?<a class="headerlink" href="#how-to-handle-an-exc
282286
<a href="twitter-labs.html" class="btn btn-neutral float-right" title="Twitter Labs" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
283287

284288

285-
<a href="../twitter-client/json.html" class="btn btn-neutral float-left" title="Json - Serialize/Deserialize" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
289+
<a href="releases.html" class="btn btn-neutral float-left" title="Releases" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
286290

287291
</div>
288292

docs/dist/more/extended-tweets.html

+4
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,10 @@
140140
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
141141
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
142142
</ul>
143+
<p class="caption"><span class="caption-text">Releases</span></p>
144+
<ul>
145+
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
146+
</ul>
143147
<p class="caption"><span class="caption-text">More</span></p>
144148
<ul class="current">
145149
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions</a></li>

docs/dist/more/help.html

+4
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,10 @@
139139
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
140140
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
141141
</ul>
142+
<p class="caption"><span class="caption-text">Releases</span></p>
143+
<ul>
144+
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
145+
</ul>
142146
<p class="caption"><span class="caption-text">More</span></p>
143147
<ul class="current">
144148
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions</a></li>

docs/dist/more/license.html

+4
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,10 @@
140140
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
141141
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
142142
</ul>
143+
<p class="caption"><span class="caption-text">Releases</span></p>
144+
<ul>
145+
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
146+
</ul>
143147
<p class="caption"><span class="caption-text">More</span></p>
144148
<ul class="current">
145149
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions</a></li>

docs/dist/more/parameters-validators.html

+4
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,10 @@
140140
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
141141
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
142142
</ul>
143+
<p class="caption"><span class="caption-text">Releases</span></p>
144+
<ul>
145+
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
146+
</ul>
143147
<p class="caption"><span class="caption-text">More</span></p>
144148
<ul class="current">
145149
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions</a></li>

0 commit comments

Comments
 (0)