Skip to content

Commit

Permalink
Update documentation and add note about Python version requirement
Browse files Browse the repository at this point in the history
  • Loading branch information
kennethreitz committed Feb 7, 2024
1 parent 676ba82 commit c9901f7
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ With ``neon_client``, developers can:
- Enhance application security by managing API keys and permissions through code.
- Leverage the power of Neon's cloud database without the need for manual intervention or the Neon console.

.. note::

This documentation is a work in progress. It is not yet complete.

This project simplifies the complexity of interacting with the Neon API, making it more accessible for developers to
build scalable, data-driven applications with ease. Pydantic dataclasses are used to represent the data structures returned
Expand All @@ -36,6 +34,10 @@ To install the package, run the following command:
$ pip install neon-client
.. note::

The package requires Python 3.10 or later.

Usage
-----

Expand Down Expand Up @@ -113,13 +115,6 @@ Classes
:undoc-members:
:show-inheritance:

--------------------

.. automodule:: neon_client.schema
:members:
:undoc-members:
:show-inheritance:


Indices and tables
==================
Expand Down

0 comments on commit c9901f7

Please sign in to comment.