Skip to content

Commit 15d0fb1

Browse files
committed
README.md: couple of minor improvements
1 parent 793773c commit 15d0fb1

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<img width="466" src="https://raw.githubusercontent.com/objectbox/objectbox-swift/master/images/logo.png">
2+
13
ObjectBox Swift (Alpha)
24
=======================
35

@@ -8,7 +10,8 @@ ObjectBox is a superfast, light-weight object persistence framework.
810
This Swift API seamlessly persists objects on-device for iOS and macOS.
911

1012
```swift
11-
try personBox.put(saintNick)
13+
let santa = Person(firstName: "Santa", lastName: "Claus")
14+
try personBox.put(santa)
1215

1316
let query: Query<Person> = personBox.query {
1417
return (Person.firstName.contains("Santa") || Person.age > 100)
@@ -17,15 +20,14 @@ let query: Query<Person> = personBox.query {
1720
let oldClauses = query.find()
1821
```
1922

20-
- **[Read the guides](https://swift.objectbox.io/)** for detailed explanations
21-
- **[Check out the API docs](http://objectbox.io/docfiles/swift/current/)**
22-
- [Visit our blog](https://objectbox.io/blog)
23+
Want details? **[Read the guides](https://swift.objectbox.io/)** or
24+
**[check out the API docs](https://objectbox.io/docfiles/swift/current/)**.
2325

2426
Installation
2527
------------
2628

2729
ObjectBox is available through [CocoaPods](https://cocoapods.org).
28-
To install it, simply add the following line to your Podfile:
30+
To install the [pod](https://cocoapods.org/pods/ObjectBox), simply add the following line to your Podfile:
2931

3032
```ruby
3133
pod 'ObjectBox'
@@ -52,10 +54,12 @@ Because your feedback is paramount!
5254
We want ObjectBox not only to be the fastest, but also to be the most Swift-friendly persistence solution.
5355
By releasing it early we can still make adjustments based on your input.
5456

55-
Thus, this preview is really all about you: what do you love? What's amiss? Where do you struggle in everyday app development?
57+
Thus, this preview is really all about you: what do you love? What's amiss?
58+
Where do you struggle in everyday app development?
5659

57-
We're looking forward to receive comments and requests:
60+
We're looking forward to receive your comments and requests:
5861

62+
- (Coming soon: short alpha questionaire)
5963
- Add [GitHub issues](https://github.com/ObjectBox/objectbox-swift/issues) and
6064
- Upvote issues you find important by hitting the 👍/+1 reaction button!
6165

@@ -75,8 +79,9 @@ Consider the following limitations:
7579
Keep in touch
7680
-------------
7781
We're obviously not finished here.
78-
[Sign up here](https://objectbox.io/ios-alpha/) for future updates on ObjectBox Swift.
82+
[Sign up here](https://objectbox.io/ios-alpha/) for future updates on ObjectBox Swift.
7983

84+
For general news on ObjectBox, [check our blog](https://objectbox.io/blog).
8085

8186
Background: Code generation
8287
---------------------------
@@ -87,9 +92,9 @@ Other languages/bindings
8792
------------------------
8893
ObjectBox is a multi platform database supporting [multiple languages](https://objectbox.io/dev-get-started/):
8994

90-
* [ObjectBox C API](https://github.com/objectbox/objectbox-c): native speed with zero copy access to FlatBuffer objects
91-
* [ObjectBox Java](https://github.com/objectbox/objectbox-java)
92-
* ObjectBox Go: coming soon
95+
* [ObjectBox C API](https://github.com/objectbox/objectbox-c): native speed with zero copy access to FlatBuffer objects;
96+
also enables porting ObjectBox to other languages.
97+
* [ObjectBox Java](https://github.com/objectbox/objectbox-java): runs on Android, desktop and even servers.
9398

9499
License
95100
-------

0 commit comments

Comments
 (0)