Skip to content

Commit d1bdebb

Browse files
committed
Changelog edits for 1.0.1 and readme fixes
1 parent 4a06bbb commit d1bdebb

File tree

2 files changed

+29
-23
lines changed

2 files changed

+29
-23
lines changed

CHANGELOG.md

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,83 @@
11
# Changelog
22

3-
Scribe-iOS follows [semantic versioning](https://semver.org/), a MAJOR.MINOR.PATCH version where increments are made of the:
3+
Scribe-iOS tries to follow [semantic versioning](https://semver.org/), a MAJOR.MINOR.PATCH version where increments are made of the:
44

55
- MAJOR version when we make incompatible API changes
66
- MINOR version when we add functionality in a backwards compatible manner
77
- PATCH version when we make backwards compatible bug fixes
88

99
Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).
1010

11-
## 1.1.0 (WIP)
11+
# 1.1.0 (WIP)
1212

13-
### 🚀 Deployment
13+
### 🌐 New Keyboards
1414

15-
- Adds baseline Russian, French and Portuguese keyboards.
15+
- Adds Russian, French and Portuguese keyboards.
16+
- Verb support is currently limited, but noun annotation, plural and `beta` translation are available.
1617

17-
### ✨ Features
18+
### New Features
1819

1920
- Adds hold-to-select functionality for symbols.
2021

21-
### 🎨 Design
22+
### 🎨 Design Changes
2223

23-
- Fixes the display of the caps lock key by making its background the key pressed color.
24+
- Improves the display of the caps lock key by making its background the key pressed color.
2425

25-
### 🗃️ Data
26+
### 🗃️ Data Added
2627

27-
<!-- -->
28+
- Adds baseline noun, verb, translation and preposition data for the new keyboards.
29+
- French:
30+
- Portuguese:
31+
- Russian:
2832

29-
### 🐛 Bug fixes
33+
### 🐛 Bug Fixes
3034

3135
- Fixes an issue with German keyboards where the dollar sign was shown on the number keys instead of the euro sign.
3236
- Fixes an issue with iPads where semicolon keys also had apostrophes.
3337
- Fixes an issue where number keys weren't able to trigger the double space period shortcut.
3438

35-
### ♻️ Refactoring
39+
### ♻️ Code Refactoring
3640

3741
- Combines all the space bar logic into one and renames the key based on the keyboard.
3842

39-
## 1.0.1 (WIP)
43+
# 1.0.1
4044

41-
### ✨ Features
45+
### New Features
4246

4347
- Adds comma-space to letter keys functionality.
4448
- Adds question mark and exclamation point followed by space to capital letter keys functionality.
4549

46-
### 🎨 Design
50+
### 🎨 Design Changes
4751

4852
- Fixes the display of the system header in the app when the user is in dark mode, as the white text was hard to read.
4953
- Fixes the display of the scroll bar in the app when the user is in dark mode, as the white bar wasn't visually appealing.
5054
- The keyboard has been made taller for iPhones to make the buttons larger vertically.
5155
- More space has been added around the buttons to make them better resemble system keyboard spacing.
5256

53-
### 🐛 Bug fixes
57+
### 🐛 Bug Fixes
5458

5559
- Fixes an issue where the select keyboard button wouldn't be able to be long held after an initial button is pressed.
5660
- Fixes an issue where canceling a command would cause the preview bar to read "Not in directory" on a subsequent command.
5761
- Fixes an issue where the double space period shortcut is triggered without intent.
5862

59-
### ♻️ Refactoring
63+
### ♻️ Code Refactoring
6064

6165
- The hold-to-select character functions are now combined into one.
6266

63-
### 🚚 File movement
67+
### 🚚 File Movement
6468

6569
- Moved the contribution guidelines to the main directory.
6670

67-
## 1.0.0
71+
# 1.0.0
6872

6973
### MVP release of Scribe - Language Keyboards
7074

7175
### 🚀 Deployment
7276

7377
- Releasing for iPhone and iPad.
78+
79+
### 🌐 Keyboards
80+
7481
- Keyboards for German and Spanish.
7582

7683
### ✨ Features
@@ -88,6 +95,9 @@ Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).
8895
- Data saved in JSON files in app to allow for quick access that doesn't require an internet connection.
8996
- Nouns, verbs and prepositions (where applicable).
9097
- Translations of English words via 🤗 Transformers.
98+
- Adds baseline noun, verb, translation and preposition data for the new keyboards.
99+
- German: 27K+ nouns, 3K+ verbs, 65K+ translations, 190 prepositions
100+
- Spanish: 8K+ nouns, 65 verbs, 65K+ translations
91101

92102
### 🎨 Design
93103

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,10 @@ https://user-images.githubusercontent.com/24387426/143763293-439fe6c8-e417-4f76-
4242
</p>
4343
</details>
4444

45-
<details><summary><strong>iPad Pro 4th gen version (mobile and desktop)</strong></summary>
46-
<p>
45+
#### iPad Pro 4th gen version
4746

4847
https://user-images.githubusercontent.com/24387426/143763680-16931dda-0d5e-4029-b1a9-f293bc1f1bba.mp4
4948

50-
</p>
51-
</details>
52-
5349
The App Store videos, images and text can be found in [Resources/AppStore](https://github.com/scribe-org/Scribe-iOS/blob/main/Resources/AppStore/). Contributions to improve them are welcome, but please [open an issue](https://github.com/scribe-org/Scribe-iOS/issues/new) to check before.
5450

5551
# Setup [``](#contents) <a id="setup"></a>

0 commit comments

Comments
 (0)