aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c5b9bcb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+### Introduction
+
+This is an ArchiCAD BIMServer/Cloud client library for Python.
+
+
+### System Requirements
+
+- pip install -r requirements.pip
+- ArchiCAD BIMServer or BIMCloud
+
+
+### Usage
+
+Example 1 - get the version number of your BIM server:
+
+```python
+import bimclient
+s = bimclient.connect('http://bim.example.com:19000')
+s.version
+```
+
+Check `tests.py` for more examples.