Skip to content

Commit ee41ad3

Browse files
committed
docs: update status in readme
1 parent a016f1a commit ee41ad3

File tree

1 file changed

+8
-42
lines changed

1 file changed

+8
-42
lines changed

README.rst

Lines changed: 8 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -34,48 +34,14 @@ Structurizr for Python
3434
3535
A Python client package for the Structurizr cloud service and on-premises installation.
3636

37-
Post Template-Instantiation Steps
38-
=================================
39-
40-
1. Start working with git.
41-
42-
.. code-block:: console
43-
44-
git init
45-
46-
2. Check for an updated versioneer.
47-
48-
.. code-block:: console
49-
50-
pip install versioneer
51-
versioneer install
52-
53-
You probably have to remove the mess in ``src/structurizr/__init__.py``.
54-
55-
3. Commit all the files.
56-
57-
.. code-block:: console
58-
59-
git add .
60-
git commit
61-
62-
4. Create a repository on `GitHub <https://github.com/>`_ if you haven't done
63-
so yet and link it to `Travis CI <https://travis-ci.org/>`_.
64-
5. Browse through the architecture decision records (``docs/adr``) if you want
65-
to understand details of the package design.
66-
6. Remove this section from the readme and describe what your package is all
67-
about.
68-
7. When you're ready to make a release, perform the following steps.
69-
70-
1. On `Travis CI <https://travis-ci.org/>`_ set the secure environment
71-
variables ``PYPI_USERNAME``, ``PYPI_PASSWORD``, and ``GITHUB_TOKEN``.
72-
2. Tag your latest commit with the desired version and let Travis handle
73-
the release.
74-
75-
.. code-block:: console
37+
Warning
38+
=======
7639

77-
git tag 0.1.0
78-
git push origin 0.1.0
40+
The structurizr-python package is in active development and should be considered Alpha
41+
software. Reports of problems are appreciated but please do not expect fully working
42+
software at this point. If you want to get involved, you are most welcome as this is
43+
a spare time project. Please write me an e-mail or on the
44+
`Structurizr Slack team <https://structurizr.com/help>`_ so that we can coordinate.
7945

8046
Install
8147
=======
@@ -84,7 +50,7 @@ It's as simple as:
8450

8551
.. code-block:: console
8652
87-
pip install structurizr-python
53+
pip install --pre structurizr-python
8854
8955
Copyright
9056
=========

0 commit comments

Comments
 (0)