Skip to content

Commit

Permalink
Added a release section in the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
linvi committed Oct 5, 2020
1 parent a0c5973 commit d150ff4
Show file tree
Hide file tree
Showing 52 changed files with 723 additions and 7 deletions.
9 changes: 8 additions & 1 deletion docs/dist/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@ The goal of this library is to make life of developers as easy as possible.
twitter-client/events
twitter-client/json

.. toctree::
:maxdepth: 1
:hidden:
:caption: Releases

more/releases

.. toctree::
:maxdepth: 1
:hidden:
Expand All @@ -98,4 +105,4 @@ The goal of this library is to make life of developers as easy as possible.
more/tweetinvi-container
more/license
more/help

71 changes: 71 additions & 0 deletions docs/dist/_sources/more/releases.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Releases

## 5.0

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.

Here are some of the major changes.

* Async/Await

> Tweetinvi is now using the Async/Await pattern in its entire code base. This will help modern development and ease up ASPNET thread pool.

* [TwitterClient](https://linvi.github.io/tweetinvi/dist/intro/basic-concepts.html#twitterclient)

> 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.

* Twitter API V2

> Support of all the endpoints of Twitter API V2!

* [Parameters](https://linvi.github.io/tweetinvi/dist/intro/basic-concepts.html#parameters)

> 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

* [Iterators](https://linvi.github.io/tweetinvi/dist/twitter-api/iterators.html)

> 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!

* [Brand new documentation](https://linvi.github.io/tweetinvi/dist/index.html)

> Tweetinvi documentation has been at the core of the new version.
> * The new documentation should explain provide examples for all the bits and pieces you can find in the Tweetinvi library.
> * All publicly available code has been annotated to explain what each method do and what they return.

* [Redesign of Account Activity](https://linvi.github.io/tweetinvi/dist/account-activity/account-activity.html)

> 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.

* .NET Compatibility

> 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!

* Support for missing endpoints

> Some endpoints were missing from the library. All endpoints in the Twitter documentation are now officially supported.

* [Redesign of Error Management](https://linvi.github.io/tweetinvi/dist/more/exceptions.html)

> Exceptions have never been a strong part of Tweetinvi. This has changed and Tweetinvi is now throwing a very limited set of Exceptions.

* Better support for special cases

> 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.

* Bug Fixes

> 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...

* Integration Tests

> 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!

* And much more

> Performance improvements, upload support, parameters validation, namespaces/code cleanup, dependencies updates, .NETCore support...

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.

I take this opportunity to thanks @JoshKeegan for his special contributions to the project.

I look forward to hearing your feedback!
4 changes: 4 additions & 0 deletions docs/dist/account-activity/account-activity-events.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/account-activity/account-activity-with-aspnet.html
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/account-activity/account-activity.html
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/authentication/authentication-pin-code.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/authentication/authentication-url-redirect.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/authentication/authentication.html
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/credentials/credentials.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/credentials/rate-limits-handlers.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/credentials/rate-limits.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,10 @@
<li class="toctree-l1"><a class="reference internal" href="twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="more/exceptions.html">Exceptions</a></li>
Expand Down
6 changes: 6 additions & 0 deletions docs/dist/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,10 @@
<li class="toctree-l1"><a class="reference internal" href="twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="more/exceptions.html">Exceptions</a></li>
Expand Down Expand Up @@ -233,6 +237,8 @@ <h1>Tweetinvi 5.0<a class="headerlink" href="#tweetinvi-5-0" title="Permalink to
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
</div>


Expand Down
4 changes: 4 additions & 0 deletions docs/dist/intro/basic-concepts.html
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/intro/getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../more/exceptions.html">Exceptions</a></li>
Expand Down
8 changes: 6 additions & 2 deletions docs/dist/more/exceptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Twitter Labs" href="twitter-labs.html" />
<link rel="prev" title="Json - Serialize/Deserialize" href="../twitter-client/json.html" />
<link rel="prev" title="Releases" href="releases.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -140,6 +140,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Exceptions</a><ul>
Expand Down Expand Up @@ -282,7 +286,7 @@ <h2>How to handle an exception?<a class="headerlink" href="#how-to-handle-an-exc
<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>


<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>
<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>

</div>

Expand Down
4 changes: 4 additions & 0 deletions docs/dist/more/extended-tweets.html
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/more/help.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/more/license.html
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions</a></li>
Expand Down
4 changes: 4 additions & 0 deletions docs/dist/more/parameters-validators.html
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,10 @@
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/events.html">Twitter Client - Events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../twitter-client/json.html">Json - Serialize/Deserialize</a></li>
</ul>
<p class="caption"><span class="caption-text">Releases</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
</ul>
<p class="caption"><span class="caption-text">More</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions</a></li>
Expand Down
Loading

0 comments on commit d150ff4

Please sign in to comment.