VAR/VAR.UrlCompressor
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Valeriano A.R.
2017-07-13 02:53:09 +02:00
parent 7069618a48
commit 6abc31a57c
1 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -1,5 +1,13 @@
# .Net library for compressing URLs # .Net library for compressing URLs
## Instalation
You can install the NuGet package using this command on the package manager:
Install-Package VAR.UrlCompressor
Alternativelly you can copy and reference the assembly resulting of the project VAR.UrlCompressor.
## Usage ## Usage
### VAR.UrlCompressor ### VAR.UrlCompressor
@@ -10,16 +18,28 @@ Add the resulting assembly as reference in your projects, and this line on code:
Compress an URL with: Compress an URL with:
string compressedUrl = UrlCompressor.Compress("https:\\google.com"); string compressedUrl = UrlCompressor.Compress("https:\\google.com");
// compressedUrl = "Hk30TGDxt8jOOW6"
Decompress an URL with: Decompress an URL with:
string decompressedUrl = UrlCompressor.Compress("xGncYbYfopHYpG0"); string decompressedUrl = UrlCompressor.Decompress("Hk30TGDxt8jOOW6");
// decompressedUrl = "Hk30TGDxt8jOOW6";
For extra compression use host conversions. For example:
Dictionary<string, string> hostConversions = new Dictionary<string, string> {
{ "google", "G" }
{ "com", "C" }
}
string compressedUrl = UrlCompressor.Compress("https:\\google.com", );
// compressedUrl = "oMyuFVR41"
### UrlCompressor.Tests ### UrlCompressor.Tests
It is a simple console application, to test basic funcitionallity of the library. It is a simple console application, to test basic funcitionallity of the library.
## Building ## Building
A Visual Studio 2015 and 2010 solutions are provided. Simply, click build on the IDE. A Visual Studio 2017 solution is provided. Simply, click build on the IDE.
A .nuget package can be build using: A .nuget package can be build using:
VAR.UrlCompressor\Build.NuGet.cmd VAR.UrlCompressor\Build.NuGet.cmd