From 107e009807f5107ecee7b8a8c1bd089254d5fca9 Mon Sep 17 00:00:00 2001 From: Geoffroy BONNEVILLE Date: Sat, 2 May 2020 13:46:26 +0200 Subject: [PATCH] Updated Readme --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index acabc2b..aa7ac6e 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,16 @@ # What is this ? ModernKeePassLib is a port of KeePassLib to .netstandard 1.2, distributed as a nuget package. -The aim was to change as little as possible the original library. However, some workarounds have to be made as .netstandard misses quite a few features of the full .net framework. +The aim was to change as little as possible the original library. However, some workarounds have to be made as .netstandard 1.2 misses quite a few features of the full .net framework. Main changes: - Removed the dependency on the filesystem - Added a dependency on Windows (I'm working on tring to find a way to remove it altogether) - Some features are handled by external nuget packages (cryptography, colors, etc.), so it may introduce small differences +# Installation + +From [nuget.org](https://www.nuget.org/packages/ModernKeePassLib/) + # Usage 1. Create a IOConnectionInfo from a byte array: @@ -29,4 +33,9 @@ compositeKey.AddUserKey(new KcpKeyFile(IOConnectionInfo.FromByteArray(KeyFileCon `PwDatabase.Save(new NullStatusLogger());` 6. At this point, nothing is commited to disk, so you need to retrieve the byte array: `var contents = PwDatabase.IOConnectionInfo.Bytes;` -7. Write the byte array to a file, to a stream, whatever ! \ No newline at end of file +7. Write the byte array to a file, to a stream, whatever ! + +# Todo + +- Remove Windows dependencies entirely +- Find a way to use Color class (handled by Splat at the moment, but I'm not satisfied) \ No newline at end of file