mirrors/vector-im-hydrogen-web
1
0
Fork 0
mirror of https://github.com/vector-im/hydrogen-web.git synced 2024-12-22 19:14:52 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1092 from vector-im/add-changelog-sdk

Browse Source 
Add Changelog for SDK
This commit is contained in:
R Midhun Suresh 2023-05-11 18:20:56 +05:30 committed by GitHub
commit 9fe9bd4ba9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/SDK-CHANGELOG.md Normal file
View File

@ -0,0 +1,25 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [version] - YYYY-MM-DD
### Added
- Added `Copy matrix.to permalink` option to message action
### Fixed
- Fix an issue where keys for encrypted messages sent from Hydrogen was not shared leading to UTDs.
- Fix documentation which failed to mention that `FeatureSet` needs to be passed into view models.
- Mention how to add `libolm` as dependency in the tutorial.
- Fix an issue where large log files were generated for long lived calls.
- Fix an issue which prevented the SDK from being used without encryption.
### Changed
- Long dates in sticky date headers are now rendered in a single line

3
doc/SDK.md
View File

@ -3,6 +3,9 @@
The Hydrogen view SDK allows developers to integrate parts of the Hydrogen application into the UI of their own application. Hydrogen is written with the MVVM pattern, so to construct a view, you'd first construct a view model, which you then pass into the view. For most view models, you will first need a running client. The Hydrogen view SDK allows developers to integrate parts of the Hydrogen application into the UI of their own application. Hydrogen is written with the MVVM pattern, so to construct a view, you'd first construct a view model, which you then pass into the view. For most view models, you will first need a running client.
## Changelog
[See CHANGELOG.md](./CHANGELOG.md)
## Example ## Example
The Hydrogen SDK requires some assets to be shipped along with your app for things like downloading attachments, and end-to-end encryption. A convenient way to make this happen is provided by the SDK (importing `hydrogen-view-sdk/paths/vite`) but depends on your build system. Currently, only [vite](https://vitejs.dev/) is supported, so that's what we'll be using in the example below. The Hydrogen SDK requires some assets to be shipped along with your app for things like downloading attachments, and end-to-end encryption. A convenient way to make this happen is provided by the SDK (importing `hydrogen-view-sdk/paths/vite`) but depends on your build system. Currently, only [vite](https://vitejs.dev/) is supported, so that's what we'll be using in the example below.

1
scripts/sdk/build.sh
View File

@ -16,6 +16,7 @@ mkdir target/paths
# this doesn't work, the ?url imports need to be in the consuming project, so disable for now # this doesn't work, the ?url imports need to be in the consuming project, so disable for now
# ./scripts/sdk/transform-paths.js ./src/platform/web/sdk/paths/vite.js ./target/paths/vite.js # ./scripts/sdk/transform-paths.js ./src/platform/web/sdk/paths/vite.js ./target/paths/vite.js
cp doc/SDK.md target/README.md cp doc/SDK.md target/README.md
cp doc/SDK-CHANGELOG.md target/CHANGELOG.md
pushd target/asset-build pushd target/asset-build
rm index.html rm index.html
popd popd