Skip to content

Commit 29743d0

Browse files
committed
(chore) CHANGELOG: Add CHANGELOG file
Bump up Peer Dependency version to 0.1.0 as pre-requisite for release. Signed-off-by: Progyan Bhattacharya <bprogyan@gmail.com>
1 parent 35692c9 commit 29743d0

3 files changed

Lines changed: 34 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# CHANGELOG
2+
3+
<!--
4+
Read this section if it's your first time writing changelog, if not read anyway.
5+
6+
Guidelines:
7+
- Don't dump commit log diffs as changelogs. Bad idea, it is.
8+
- Changelogs are for humans, not machines.
9+
- There should be an entry for every single version.
10+
- The same types of changes should be grouped.
11+
- the latest version comes first.
12+
13+
Tags:
14+
- Added: for new features.
15+
- Changed: for changes in existing functionality.
16+
- Deprecated: for soon-to-be removed features.
17+
- Removed: for now removed features.
18+
- Fixed: for any bug fixes.
19+
- Security: in case of vulnerabilities.
20+
21+
Good to have: commit or PR links.
22+
23+
-->
24+
25+
## [v0.1.0](https://github.com/Progyan1997/Operational-Transformation/tree/v0.1.0)
26+
27+
### Added
28+
29+
- Add package `@operational-transformation/plaintext` - Handles Trannsformation Logic related to Plain Text content and content changes.
30+
- Add package `@operational-transformation/plaintext-editor` - Handles integration between a Plain Text Editor and a Central Server, and keeps contents of all Plain Text Editors associated with the Central Server in sync via Plain Text Operational Transformations.
31+
- Add package `@operational-transformation/state-machine` - Handles State Transitions and Side Effects in each stages of Synchronization between Client (e.g., Editor) and Server.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
"test:watch": "yarn test --watch",
1010
"lint": "yarn lint:lockfile && yarn lint:prettier",
1111
"lint:prettier": "prettier --write packages/**/*.ts",
12-
"lint:lockfile": "check-yarn-lock"
12+
"lint:lockfile": "check-yarn-lock",
13+
"release": "lerna version --no-private --exact"
1314
},
1415
"repository": {
1516
"type": "git",

packages/plaintext-editor/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
"mitt": "3.0.0"
4646
},
4747
"peerDependencies": {
48-
"@operational-transformation/plaintext": "^0.0.0"
48+
"@operational-transformation/plaintext": "^0.1.0"
4949
},
5050
"peerDependenciesMeta": {
5151
"@operational-transformation/plaintext": {

0 commit comments

Comments
 (0)