From 324fef8f3f2df5e853f79d0680d62c7fb9bfb671 Mon Sep 17 00:00:00 2001 From: zadam Date: Sun, 24 Dec 2017 22:33:36 -0500 Subject: [PATCH 1/4] Create README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000000..739dc5624f --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# Trilium +Hierarchical note taking application + +![Trilium screenshot](wiki/images/screenshot.png?raw=true "Title") + +[[wiki/images/screenshot.png]] From 15c3b4c4acccc6d503677f3c4825372051be6f33 Mon Sep 17 00:00:00 2001 From: zadam Date: Sun, 24 Dec 2017 22:34:57 -0500 Subject: [PATCH 2/4] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 739dc5624f..d6ae700192 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ # Trilium Hierarchical note taking application -![Trilium screenshot](wiki/images/screenshot.png?raw=true "Title") - -[[wiki/images/screenshot.png]] +![](https://raw.githubusercontent.com/wiki/zadam/trilium/images/screenshot.png) From 2e346740e38bca9093ed985198bd00c5f3a8ed5a Mon Sep 17 00:00:00 2001 From: zadam Date: Sun, 24 Dec 2017 22:47:06 -0500 Subject: [PATCH 3/4] Update README.md --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6ae700192..94519b5470 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,24 @@ # Trilium -Hierarchical note taking application +Hierarchical note taking application. ![](https://raw.githubusercontent.com/wiki/zadam/trilium/images/screenshot.png) + +## Features + +* Notes can be arranged into arbitrarily deep hierarchy + * Notes can have more than 1 parents - see [cloning](https://github.com/zadam/trilium/wiki/Cloning) +* WYSIWYG (What You See Is What You Get) editing +* Fast and easy [navigation between notes](https://github.com/zadam/trilium/wiki/Note-navigation) +* Seamless note versioning +* Can be deployed as web application and / or desktop application with offline access (electron based) +* [Synchronization with](https://github.com/zadam/trilium/wiki/Synchronization) self-hosted sync server +* Strong [note encryption](https://github.com/zadam/trilium/wiki/Protected-notes) + +## Builds + +* If you want to install Trilium on server, follow [this page](https://github.com/zadam/trilium/wiki/Installation-on-server) +* If you want to use Trilium on the desktop, download binary release from [releases], unzip the package and run ```trilium``` executable. + +## Documentation + +See [wiki](https://github.com/zadam/trilium/wiki/Home) for complete list of available pages. From 9fc9a73b8a57497241d6dffdd9be93a44cf51b52 Mon Sep 17 00:00:00 2001 From: zadam Date: Sun, 24 Dec 2017 22:52:35 -0500 Subject: [PATCH 4/4] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 94519b5470..76286a2872 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,14 @@ Hierarchical note taking application. * If you want to install Trilium on server, follow [this page](https://github.com/zadam/trilium/wiki/Installation-on-server) * If you want to use Trilium on the desktop, download binary release from [releases], unzip the package and run ```trilium``` executable. +## Supported platforms + +Desktop (electron) builds are available for Linux and Windows. + +Requirements for web based installation are outlined in (https://github.com/zadam/trilium/wiki/Installation-on-server). + +Currently only recent Chrome and Firefox are supported (tested) browsers. Other modern browsers should work as well. + ## Documentation See [wiki](https://github.com/zadam/trilium/wiki/Home) for complete list of available pages.