Skip to content

Commit

Permalink
📝 Add proper header in README.md (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ousret authored Nov 14, 2023
1 parent af7b1c4 commit e5b90f5
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Niquests
<div align="center">
<img src="https://user-images.githubusercontent.com/9326700/282852138-160f32e9-e6cf-495f-b39d-99891602acf9.png" alt="Niquests Logo"/>
</div>

**Niquests** is a simple, yet elegant, HTTP library. It is a drop-in replacement for **Requests** that is no longer under
feature freeze.
Expand Down Expand Up @@ -77,4 +79,4 @@ We intend to keep it that way. As long as we can, long live Niquests!

---

[![Kenneth Reitz](https://raw.githubusercontent.com/jawah/niquests/main/ext/kr.png)](https://kennethreitz.org) [![Python Software Foundation](https://raw.githubusercontent.com/psf/requests/main/ext/psf.png)](https://www.python.org/psf)
[![Kenneth Reitz](https://raw.githubusercontent.com/jawah/niquests/main/ext/kr.png)](https://kennethreitz.org)
6 changes: 6 additions & 0 deletions docs/user/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,12 @@ You may specify the private key passphrase using the following example::
>>> niquests.get('https://kennethreitz.org', cert=('/path/client.cert', '/path/client.key', 'my_key_password'))
<Response HTTP/2 [200]>

In-memory Certificates
----------------------

The ``cert=...`` and ``verify=...`` can actually take the certificates themselves. Niquests support
in-memory certificates instead of file paths.

.. _ca-certificates:

CA Certificates
Expand Down
2 changes: 1 addition & 1 deletion docs/user/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ netrc Authentication
~~~~~~~~~~~~~~~~~~~~

If no authentication method is given with the ``auth`` argument and the
Authorization header has not been set, Requests will attempt to get the
Authorization header has not been set, Niquests will attempt to get the
authentication credentials for the URL's hostname from the user's netrc file.

If credentials for the hostname are found, the request is sent with HTTP Basic
Expand Down

0 comments on commit e5b90f5

Please sign in to comment.