Skip to content

Commit accf561

Browse files
committed
Fix typos
1 parent dcebc77 commit accf561

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
[![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg?style=flat-square)](https://ktlint.github.io/)
66

77
# 🚧 WORK IN PROGRESS 🚧
8-
This library is currently in pre-alpha and should **not** be used in production. Stable release coming very soon!
8+
This library is currently in pre-alpha and should **not** be used in production. Stable release coming shortly!
99

1010
# ![logo](https://github.com/adrielcafe/pufferdb/blob/master/logo.png?raw=true) PufferDB
1111

1212
**PufferDB** is a :zap: key-value database powered by **P**rotocol B**uffer**s (aka [Protobuf](https://developers.google.com/protocol-buffers/)).
1313

14-
The intent of this library is to provide a efficient, reliable and Android **independent** storage.
14+
The purpose of this library is to provide an efficient, reliable and Android **independent** storage.
1515

16-
Why Android independent? The SharedPreferences and many great third-party libraries (like [Paper](https://github.com/pilgr/Paper/) and [MMKV](https://github.com/Tencent/MMKV/)) requires the Android Context to work (they're Android *dependents*). But if you are like me and want a **kotlin-only data module** (following the principles of [Clean Architecture](https://antonioleiva.com/clean-architecture-android/)), this library is for you!
16+
Why Android independent? The [SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences) and many great third-party libraries (like [Paper](https://github.com/pilgr/Paper/) and [MMKV](https://github.com/Tencent/MMKV/)) requires the Android Context to work (they're Android *dependents*). But if you are like me and want a **kotlin-only data module** (following the principles of [Clean Architecture](https://antonioleiva.com/clean-architecture-android/)), this library is for you!
1717

1818
### About Protobuf
1919

@@ -23,7 +23,7 @@ Protocol Buffers are a language-neutral, platform-neutral extensible mechanism f
2323
* Fast (benchmark coming soon™)
2424
* Works on [Android and JVM](#platform-compatibility)
2525
* [Simple API](#core)
26-
* [Thread-safe](#thread-safe)
26+
* [Thread-safe](#threading)
2727
* Wrappers for [Coroutines](#coroutines) and [RxJava](#rxjava)
2828

2929
### Supported types
@@ -77,7 +77,7 @@ Current version: [![JitPack](https://img.shields.io/jitpack/v/github/adrielcafe/
7777
### Core
7878
As the name suggests, Core is a standalone module and all other modules depends on it.
7979

80-
It's API is similar to `SharedPreferences`:
80+
Its API is similar to `SharedPreferences`:
8181

8282
```kotlin
8383
val pufferFile = File("path/to/puffer/file")
@@ -103,14 +103,14 @@ puffer.apply {
103103
}
104104
```
105105

106-
But unlikely `SharedPreferences`, there's no `apply()` or `commit()`. Changes are saved every time a write operations happens.
106+
But unlike `SharedPreferences`, there's no `apply()` or `commit()`. Changes are saved every time a write operation happens.
107107

108108
PufferDB keeps an immutable and read-only memory cache for fast reads.
109109

110110
#### Threading
111-
PufferDB uses the [`ReentrantReadWriteLock`](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.html) to ensure that read-write operations will run concurrently.
111+
PufferDB uses the [`ReentrantReadWriteLock`](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.html) to ensure thread-safe read-write operations.
112112

113-
You *can* run the API methods in the Android Main Thread, but you *shouldn't* do that! Please, use one of the wrapper modules or extension functions instead.
113+
You *can* run the API methods on the Android Main Thread, but you *shouldn't* do this! Please, use one of the wrapper modules or built in extension functions instead.
114114

115115
### Android
116116
The Android module contains an `AndroidPufferDB` helper class:

buildSrc/build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ plugins {
44

55
repositories {
66
jcenter()
7-
}
7+
}

0 commit comments

Comments
 (0)