Skip to content
This repository was archived by the owner on Jan 13, 2023. It is now read-only.

Commit b409ffd

Browse files
committed
Added beta warnings to README.
1 parent ae5770a commit b409ffd

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
=====
55
PyOTA
66
=====
7+
.. warning::
8+
⚠️ This is pre-release software; it may have performance or stability issues.
9+
Please do not use this software on mainnet until v2.0.0 stable is released. ⚠️
10+
711
This is the official Python library for the IOTA Core.
812

913
It implements both the `official API`_, as well as newly-proposed functionality
@@ -28,9 +32,13 @@ PyOTA is compatible with Python 3.6, 3.5 and 2.7.
2832
============
2933
Installation
3034
============
35+
.. warning::
36+
⚠️ This is pre-release software; it may have performance or stability issues.
37+
Please do not use this software on mainnet until v2.0.0 stable is released. ⚠️
38+
3139
To install the latest version::
3240

33-
pip install pyota
41+
pip install --pre pyota
3442

3543
Optional C Extension
3644
====================
@@ -39,7 +47,7 @@ cryptography features significantly (speedups of **60x** are common!).
3947

4048
To install this extension, use the following command::
4149

42-
pip install pyota[ccurl]
50+
pip install --pre pyota[ccurl]
4351

4452

4553
Installing from Source

0 commit comments

Comments
 (0)