Skip to content

Commit 9b19c1c

Browse files
README: fix most linter issues
1 parent a1db7f7 commit 9b19c1c

File tree

1 file changed

+48
-45
lines changed

1 file changed

+48
-45
lines changed

README.md

Lines changed: 48 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<img width="466" src="https://raw.githubusercontent.com/objectbox/objectbox-swift/master/images/logo.png">
2+
<img width="466" src="https://raw.githubusercontent.com/objectbox/objectbox-swift/master/images/logo.png" alt="ObjectBox">
33
</p>
44

55
<p align="center">
@@ -21,8 +21,7 @@
2121
</a>
2222
</p>
2323

24-
Swift Database - swiftly persist objects and on-device vector database for iOS & macOS
25-
===============
24+
# Swift Database - swiftly persist objects and on-device vector database for iOS & macOS
2625

2726
Powerful & superfast database for Swift that's also easy to use. Persist Swift objects quickly and reliably on-device on iOS and macOS.
2827

@@ -72,6 +71,7 @@ Want details? **[Read the guides](https://swift.objectbox.io/)** or
7271
Simple but powerful; frugal but fast: The ObjectBox NoSQL database offers an intuitive Swift API that's easy to pick up, fun to work with, and incredibly fast, making it sustainable in many ways. Its frugal recource use (CPU, memory, battery / power) makes ObjectBox an ideal and sustainable choice for iOS apps. So why not give it a try right away? Check out the [installation section below](#adding-objectbox-to-your-project). You can also star this repository for later 🌟
7372

7473
### Features
74+
7575
🧠 **Artificial Intelligence** - superfast [on-device vector search](https://docs.objectbox.io/on-device-ann-vector-search).\
7676
🏁 **High performance** on restricted devices, like IoT gateways, micro controllers, ECUs etc.\
7777
💚 **Resourceful** with minimal CPU, power and Memory usage for maximum flexibility and sustainability\
@@ -87,9 +87,10 @@ Simple but powerful; frugal but fast: The ObjectBox NoSQL database offers an int
8787
👥 **[ObjectBox Sync](https://objectbox.io/sync/):** keeps data in sync between devices and servers\
8888
🕒 **[ObjectBox TS](https://objectbox.io/time-series-database/):** time series extension for time based data
8989

90+
<a name="cocoapods"></a>
91+
92+
## Adding ObjectBox to your project
9093

91-
<a name="cocoapods"></a>Adding ObjectBox to your project
92-
--------------------------------------------------------
9394
ObjectBox is available as a [CocoaPods](https://cocoapods.org) pod. [See the docs](https://swift.objectbox.io/install) for details and alternative setup options.
9495

9596
If you are new to CocoaPods, [check out their website](https://cocoapods.org) for an introduction and installation instructions.
@@ -116,7 +117,9 @@ e.g. check the [getting started guide](https://swift.objectbox.io/getting-starte
116117

117118
If `pod install` fails, try updating CocoaPods first:
118119

119-
gem update xcodeproj && gem update cocoapods && pod repo update
120+
```bash
121+
gem update xcodeproj && gem update cocoapods && pod repo update
122+
```
120123

121124
## Updating to newer ObjectBox versions
122125

@@ -128,8 +131,10 @@ pod update ObjectBox
128131
Pods/ObjectBox/setup.rb
129132
```
130133

131-
<a name="example"></a>Example
132-
-----------------------------
134+
<a name="example"></a>
135+
136+
## Example
137+
133138
In the [Example](Example/) directory, you'll find a "Notes" example app demonstrating ObjectBox's Swift API.
134139
The example comes with two apps: one for iOS and one for macOS. The iOS example is a full GUI application, whereas the macOS example runs a few operations and then exits.
135140

@@ -144,71 +149,69 @@ Here's a list of ObjectBox releases, and the Swift versions they were compiled w
144149
| 1.9.2 | 5.9 |
145150
| 1.9.1 | 5.9 |
146151
| 1.9.0 | 5.8.1 |
147-
| 1.8.1 | 5.7.2 |
148-
| 1.8.0 | 5.7.1 |
149-
| 1.7.0 | 5.5 |
150-
| 1.6.0 | 5.4 |
151-
| 1.5.0 | 5.3(.2) |
152-
| 1.4.1 | 5.3 |
153-
| 1.3, 1.4.0 | 5.2 |
152+
| 1.8.1 | 5.7.2 |
153+
| 1.8.0 | 5.7.1 |
154+
| 1.7.0 | 5.5 |
155+
| 1.6.0 | 5.4 |
156+
| 1.5.0 | 5.3(.2) |
157+
| 1.4.1 | 5.3 |
158+
| 1.3, 1.4.0 | 5.2 |
154159
| 1.2 | 5.1 |
155160

156161
This might be relevant, e.g. when using Carthage. For various reasons, we recommend using the latest version.
157162

158-
Development
159-
-----------
163+
## Development
164+
160165
The source code for ObjectBox's Swift binding can be found [in the Source folder](Source/README.md) of this repository.
161166

162-
Background: code generation
163-
---------------------------
167+
## Background: code generation
168+
164169
ObjectBox Swift Database generates code at build time for optimal performance at runtime by avoiding reflection etc.
165170
This is automatically done for you and should be transparent.
166171
Internally, we use [a fork of Sourcery](https://github.com/objectbox/objectbox-swift-generator) for this.
167172

168-
Already using ObjectBox?
169-
---------------------------
173+
## Already using ObjectBox?
170174

171175
We're on a mission to bring joy, delight and sustainability to app developers. **To do this, we need your help:** Please fill in this 2-minute [Anonymous Feedback Form](https://forms.gle/LvVjN6jfFHuivxZX6). Let us know what you love and what is amiss, so we can improve.
172176

173177
**We're looking forward to receiving your comments and requests:**
174178

175-
- Add [GitHub issues](https://github.com/ObjectBox/objectbox-swift/issues)
179+
- Add [GitHub issues](https://github.com/ObjectBox/objectbox-swift/issues)
176180
- Upvote issues you find important by hitting the 👍/+1 reaction button
177181
- Drop us a line via [@ObjectBox_io](https://twitter.com/ObjectBox_io/)
178-
- ⭐ us, if you like what you see
182+
- ⭐ us, if you like what you see
179183

180184
Thank you! 🙏
181185

182186
Keep in touch: For general news on ObjectBox, [check our blog](https://objectbox.io/blog)!
183187

188+
## Cross-platform database: Mobile, Desktop, Browser, Embedded, IoT
184189

185-
Cross-platform database: Mobile, Desktop, Browser, Embedded, IoT
186-
------------------------
187-
ObjectBox is a cross-platform database supporting sustainable app development in [multiple native languages](https://objectbox.io/dev-get-started/):
190+
ObjectBox is a cross-platform database supporting sustainable app development in [multiple native languages](https://objectbox.io/dev-get-started/):
188191

189-
* [Flutter/Dart Database](https://github.com/objectbox/objectbox-dart): persist Dart objects & build cross-platform apps using Flutter.
190-
* [C and C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to objects on embedded devices
191-
* [Java/Kotlin Database](https://github.com/objectbox/objectbox-java): runs on Android, desktop, and servers.
192-
* [Golang Database](https://github.com/objectbox/objectbox-go): great for IoT, data-driven tools, and server applications.
192+
- [Flutter/Dart Database](https://github.com/objectbox/objectbox-dart): persist Dart objects & build cross-platform apps using Flutter.
193+
- [C and C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to objects on embedded devices
194+
- [Java/Kotlin Database](https://github.com/objectbox/objectbox-java): runs on Android, desktop, and servers.
195+
- [Golang Database](https://github.com/objectbox/objectbox-go): great for IoT, data-driven tools, and server applications.
193196
also enables porting ObjectBox to other languages.
194197

198+
## License
195199

196-
License
197-
-------
200+
```text
201+
Copyright 2018-2024 ObjectBox Ltd. All rights reserved.
198202
199-
Copyright 2018-2024 ObjectBox Ltd. All rights reserved.
200-
201-
Licensed under the Apache License, Version 2.0 (the "License");
202-
you may not use this file except in compliance with the License.
203-
You may obtain a copy of the License at
204-
205-
http://www.apache.org/licenses/LICENSE-2.0
206-
207-
Unless required by applicable law or agreed to in writing, software
208-
distributed under the License is distributed on an "AS IS" BASIS,
209-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
210-
See the License for the specific language governing permissions and
211-
limitations under the License.
203+
Licensed under the Apache License, Version 2.0 (the "License");
204+
you may not use this file except in compliance with the License.
205+
You may obtain a copy of the License at
206+
207+
http://www.apache.org/licenses/LICENSE-2.0
208+
209+
Unless required by applicable law or agreed to in writing, software
210+
distributed under the License is distributed on an "AS IS" BASIS,
211+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
212+
See the License for the specific language governing permissions and
213+
limitations under the License.
214+
```
212215

213216
Note that this license applies to the code in this repository only.
214217
See our website on details about all [licenses for ObjectBox components](https://objectbox.io/faq/#license-pricing).

0 commit comments

Comments
 (0)