Skip to content

Commit

Permalink
minor adds to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
subhashb committed Mar 23, 2024
1 parent 0cc3c46 commit f05094c
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 4 deletions.
7 changes: 4 additions & 3 deletions docs/user/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,16 +95,17 @@ Use the ``protean`` command-line utility to verify the installation:

.. code-block:: shell
$ protean --version
$ python -m protean --version
0.11.0
To verify that Protean can be seen by Python, try importing Proteam from a ``python`` shell:
To verify that Protean can be seen by your current installation of Python,
try importing Protean from a ``python`` shell:

.. code-block:: shell
$ python3
>>> import protean
>>> print(protean.get_version())
>>> protean.get_version()
0.11.0
-------------------
Expand Down
18 changes: 17 additions & 1 deletion docs/user/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,23 @@ Quickstart

Eager to get started? This page gives a good introduction to Protean. Follow :doc:`installation` to set up a project and install Protean first.

In this quickstart, we will write a simple Protean application with SQLITE as the database and Flask as the API framework.
In this quickstart, we will create a simple Protean application with SQLITE as the database and Flask as the API framework.

Initialize a Project
--------------------

Let us initialize a new directory for your project. We will call it ``authentication``.

From the command line, cd into a directory where you’d like to store your code, then run the following command:

.. code-block:: shell
$ protean new authentication
This will create a ``authentication`` directory in your current directory.

Here is a quicklook at the directory structure:


A Simple Domain
---------------
Expand Down

0 comments on commit f05094c

Please sign in to comment.