From d7cd08a31a2b28f9e3ffd0129fa4f26d062fcc84 Mon Sep 17 00:00:00 2001 From: Alberto Spelta Date: Mon, 18 Mar 2024 14:54:54 +0100 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b52bd5..7a1c2d2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # VertiPaq-Analyzer Obfuscator -VertiPaq Analyzer Obfuscator is an integration library for .NET, enabling the obfuscation of VertiPaq Analyzer files. +VertiPaq Analyzer Obfuscator is a .NET library that enables the obfuscation of VertiPaq Analyzer files. + +You can read more [here](https://www.sqlbi.com/blog/marco/2024/03/15/vpax-obfuscator-a-library-to-obfuscate-vpax-files). ### Installation @@ -32,6 +34,18 @@ var obfuscator = new VpaxObfuscator(); obfuscator.Deobfuscate(vpax, dictionary); ``` +**Incremental Obfuscation** + +> Incremental obfuscation keeps the same obfuscated names across different VPAX versions of the same model. + +```csharp +using var vpax = File.Open(@"C:\path\to\file.vpax", FileMode.Open); +var dictionaryV1 = ObfuscationDictionary.ReadFrom(@"C:\path\to\dictionary-v1.json"); +var obfuscator = new VpaxObfuscator(); +var dictionaryV2 = obfuscator.Obfuscate(vpax, dictionaryV1); +dictionaryV2.WriteTo(@"C:\path\to\dictionary-v2.json"); +``` + ## CLI A command-line interface is also available for the obfuscator. The CLI is available as a standalone executable, which can be downloaded from the [releases page](https://github.com/sql-bi/Vpax-Obfuscator/releases/latest).