Skip to content

Commit

Permalink
README.md: minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
greenrobot committed Jun 13, 2023
1 parent a2bd359 commit 77fb331
Showing 1 changed file with 14 additions and 21 deletions.
35 changes: 14 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,8 @@
ObjectBox Python API
====================

[ObjectBox](https://objectbox.io) is a superfast database for objects, now also available for Python with a simple CRUD API.

* Python version: 3.4+
* Platforms supported:
* Linux x86-64 (64-bit)
* Linux ARMv6hf (e.g. Raspberry PI Zero)
* Linux ARMv7hf (e.g. Raspberry PI 3)
* MacOS x86-64 (64-bit)
* MacOS arm64 (Apple silicon)
* Windows x86-64 (64-bit)

[ObjectBox](https://objectbox.io) is a superfast database for objects, now also available for Python (3.4+) with a simple CRUD API.
And because it's an embedded database, there's no setup required.

## Table of Contents:
- [Getting Started](#getting-started)
- [Model IDs and UIDs](#model-ids-and-uids)
Expand All @@ -27,7 +18,6 @@ ObjectBox Python API

Getting started
---------------

First of all, install the latest version:

```bash
Expand Down Expand Up @@ -122,13 +112,18 @@ For more information and code examples, see the tests folder. The docs for other

Some features
-------------

* automatic transactions (ACID compliant)
* bulk operations
* Automatic transactions (ACID compliant)
* Bulk operations
* Vector types, e.g. for AI vector embeddings
* Platforms supported with native speed:
* Linux x86-64 (64-bit)
* Linux ARMv6hf (e.g. Raspberry PI Zero)
* Linux ARMv7hf (e.g. Raspberry PI 3; available only on request)
* MacOS x86-64 and arm64 (Intel 64-bit and Apple Silicon)
* Windows x86-64 (64-bit)

Coming in the future
--------------------

The goodness you know from the other ObjectBox language-bindings, e.g.,

* model management (no need to manually set id/uid)
Expand All @@ -140,23 +135,21 @@ The goodness you know from the other ObjectBox language-bindings, e.g.,

Help wanted
-----------

ObjectBox for Python is still in an early stage with limited feature set (compared to other languages).
ObjectBox for Python is still in an early stage with limited feature set (compared to our other supported languages).
To bring all these features to Python, we're asking the community to help out. PRs are more than welcome!
The ObjectBox team will try its best to guide you and answer questions.
See [CONTRIBUTING.md](https://github.com/objectbox/objectbox-python/blob/main/CONTRIBUTING.md) to get started.

Feedback
--------

Also, please let us know your feedback by opening an issue: for example, if you experience errors or if you have ideas
for how to improve the API. Thanks!

License
-------

```text
Copyright 2019-2021 ObjectBox Ltd. All rights reserved.
Copyright 2019-2023 ObjectBox Ltd. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down

0 comments on commit 77fb331

Please sign in to comment.