Skip to content

Commit

Permalink
Update README.md (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
albertospelta authored Mar 18, 2024
1 parent 8162c13 commit 3bf3834
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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).
Expand Down

0 comments on commit 3bf3834

Please sign in to comment.