Skip to content
This repository was archived by the owner on Mar 4, 2023. It is now read-only.

Commit b65b26e

Browse files
committed
doc update
1 parent 68f4a5c commit b65b26e

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,16 @@ A simple offline-first synchronisation framework, to synchronize data of Qt appl
99
- Document-Store like access, using QObjects and Q_GADGET classes
1010
- Asynchronous access, general access to all data, with futures and onResult handler
1111
- Synchronous access with caching store per datatype
12+
- Qt "model" class (`QAbstractListModel`) to view store data in item views
1213
- Stable offline storage, to make shure apps work even without network
1314
- Remote synchronisation between devices
1415
- Multi-user and multi-device system - data is synchronized per user on all his devices
1516
- Includes server application as backend, websocket based
1617
- Controller class to control and monitor sync state
1718
- Works "out of the box", since all components are provided
18-
- Can be used a simple local store only
19+
- Can be used as simple local store only
1920
- Includes a docker-compose file for a PostgreSQL server
21+
- Class to exchange user identities between devices in a local network
2022
- Highly extensible
2123

2224
## Requirements
@@ -39,7 +41,7 @@ To actually run the server, it needs to connect to a SQL Database. A little more
3941
7. You can install either all of my modules, or select the one you need: `Qt Data Sync`
4042
8. Continue the setup and thats it! you can now use the module for all of your installed Kits for that Qt Version
4143
3. Download the compiled modules from the release page. **Note:** You will have to add the correct ones yourself and may need to adjust some paths to fit your installation! In addition to that, you will have to download the modules this one depends on as well.
42-
4. Build it yourself! **Note:** This requires perl to be installed, as well as all dependencies. If you don't have/need cmake, you can ignore the related warnings. To automatically build and install to your Qt installation, run:
44+
4. Build it yourself! **Note:** This requires perl and qpm to be installed, as well as all dependencies. If you don't have/need cmake, you can ignore the related warnings. To automatically build and install to your Qt installation, run:
4345
- `cd src/3rdparty && qpm install && cd ../..`
4446
- `qmake`
4547
- `make qmake_all`

src/datasync/wsauthenticator.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public Q_SLOTS:
6363
void setCustomHeaders(QHash<QByteArray, QByteArray> customHeaders);
6464
//! @writeAcFn{WsAuthenticator::validateServerCertificate}
6565
void setValidateServerCertificate(bool validateServerCertificate);
66-
//! @reseteAcFn{WsAuthenticator::userData}
66+
//! @resetAcFn{WsAuthenticator::userData}
6767
GenericTask<void> resetUserData(bool clearLocalStore = true);
6868
//! @writeAcFn{WsAuthenticator::serverSecret}
6969
void setServerSecret(QString serverSecret);

0 commit comments

Comments
 (0)