README.md

bytecode77 · Dec 9, 2023 · 5fc522e · 5fc522e
1 parent 1040086
commit 5fc522e
Show file tree

Hide file tree

Showing 30 changed files with 330 additions and 30 deletions.
diff --git a/BytecodeApi.CommandLineParser/.nuget/README.md b/BytecodeApi.CommandLineParser/.nuget/README.md
@@ -1,3 +1,13 @@
 # BytecodeApi.CommandLineParser
 
-Library for commandline parsing and handling.
+Library for commandline parsing and handling.
+
+## Examples
+
+See: [Examples](https://github.com/bytecode77/bytecode-api/blob/master/BytecodeApi.CommandLineParser/README.md)
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.CommandLineParser/README.md b/BytecodeApi.CommandLineParser/README.md
@@ -96,4 +96,10 @@ new OptionSet("-", "--")
 	);
 ```
 
-</details>
+</details>
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.ConsoleUI/.nuget/README.md b/BytecodeApi.ConsoleUI/.nuget/README.md
@@ -1,3 +1,13 @@
 # BytecodeApi.ConsoleUI
 
-Console input & output library.
+Console input & output library.
+
+## Examples
+
+See: [Examples](https://github.com/bytecode77/bytecode-api/blob/master/BytecodeApi.ConsoleUI/README.md)
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.ConsoleUI/README.md b/BytecodeApi.ConsoleUI/README.md
@@ -142,4 +142,10 @@ ConsoleInput.Theme.ConfirmationAnswerYes = "y";
 ConsoleInput.Theme.SelectOptionsPromptText = "Select:";
 ```
 
-</details>
+</details>
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.Cryptography/.nuget/README.md b/BytecodeApi.Cryptography/.nuget/README.md
@@ -1,3 +1,13 @@
 # BytecodeApi.Cryptography
 
-Library for encryption & hashing and other cryptographic operations.
+Library for encryption & hashing and other cryptographic operations.
+
+## Examples
+
+See: [Examples](https://github.com/bytecode77/bytecode-api/blob/master/BytecodeApi.Cryptography/README.md)
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.Cryptography/README.md b/BytecodeApi.Cryptography/README.md
@@ -144,4 +144,10 @@ Console.WriteLine(bloom.Contains("hello") ? "maybe" : "no");
 Console.WriteLine(bloom.Contains("world") ? "maybe" : "no");
 Console.WriteLine(bloom.Contains("foobar") ? "maybe" : "no");
 ```
-</details>
+</details>
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.CsvParser/.nuget/README.md b/BytecodeApi.CsvParser/.nuget/README.md
@@ -1,3 +1,13 @@
 # BytecodeApi.CsvParser
 
-Library for CSV parsing and writing.
+Library for CSV parsing and writing.
+
+## Examples
+
+See: [Examples](https://github.com/bytecode77/bytecode-api/blob/master/BytecodeApi.CsvParser/README.md)
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.CsvParser/README.md b/BytecodeApi.CsvParser/README.md
@@ -78,4 +78,10 @@ IEnumerable<CsvRow> GetRows()
 }
 ```
 
-</details>
+</details>
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.IniParser/.nuget/README.md b/BytecodeApi.IniParser/.nuget/README.md
@@ -1,3 +1,13 @@
 # BytecodeApi.IniParser
 
-Library for INI file reading and writing.
+Library for INI file reading and writing.
+
+## Examples
+
+See: [Examples](https://github.com/bytecode77/bytecode-api/blob/master/BytecodeApi.IniParser/README.md)
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.IniParser/README.md b/BytecodeApi.IniParser/README.md
@@ -129,4 +129,10 @@ IniFileFormattingOptions formattingOptions = new()
 
 iniFile.Save(@"C:\path\to\file.ini", Encoding.UTF8, formattingOptions);
 ```
-</details>
+</details>
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.LanguageGenerator/.nuget/README.md b/BytecodeApi.LanguageGenerator/.nuget/README.md
@@ -1,3 +1,13 @@
 # BytecodeApi.LanguageGenerator
 
-Library for arbitrary generation of words, sentences, names, and other language elements.
+Library for arbitrary generation of words, sentences, names, and other language elements.
+
+## Examples
+
+See: [Examples](https://github.com/bytecode77/bytecode-api/blob/master/BytecodeApi.LanguageGenerator/README.md)
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.LanguageGenerator/README.md b/BytecodeApi.LanguageGenerator/README.md
@@ -69,4 +69,10 @@ string randomText = textGenerator.Generate();
 ## See also
 
 * `NameGenerator` to generate first/last names
-* `LoremIpsumGenerator` to generate text placeholders with lorem ipsum paragraphs.
+* `LoremIpsumGenerator` to generate text placeholders with lorem ipsum paragraphs.
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.Lexer/.nuget/README.md b/BytecodeApi.Lexer/.nuget/README.md
@@ -1,3 +1,18 @@
 # BytecodeApi.Lexer
 
-General purpose tokenizer for parsing of any syntax.
+General purpose tokenizer for parsing of any syntax.
+
+## Examples
+
+See: [Examples](https://github.com/bytecode77/bytecode-api/blob/master/BytecodeApi.Lexer/README.md)
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
+
+### 3.0.1 (27.09.2023)
+
+* **new:** `Lexer` method overloads with `RegexOptions` parameter
+* **change:** Replaced `Func<string, string>?` parameters with `Func<Match, string>?`
diff --git a/BytecodeApi.Lexer/README.md b/BytecodeApi.Lexer/README.md
@@ -41,4 +41,15 @@ Finally, to tokenize a string, call the `Parse` method. The result is a collecti
 string formula = "(3 + 4) * 15 / ((-10 - 5) * 3)";
 TokenCollection<FormulaTokenType> tokens = lexer.Parse(formula);
 ```
-</details>
+</details>
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
+
+### 3.0.1 (27.09.2023)
+
+* **new:** `Lexer` method overloads with `RegexOptions` parameter
+* **change:** Replaced `Func<string, string>?` parameters with `Func<Match, string>?`
diff --git a/BytecodeApi.PEParser/.nuget/README.md b/BytecodeApi.PEParser/.nuget/README.md
@@ -1,3 +1,13 @@
 # BytecodeApi.PEParser
 
-Library for PE file parsing.
+Library for PE file parsing.
+
+## Examples
+
+See: [Examples](https://github.com/bytecode77/bytecode-api/blob/master/BytecodeApi.PEParser/README.md)
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release.
diff --git a/BytecodeApi.PEParser/README.md b/BytecodeApi.PEParser/README.md
@@ -26,4 +26,10 @@ foreach (ImageSection section in exe.Sections)
 	}
 }
 ```
-</details>
+</details>
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.PEResources/.nuget/README.md b/BytecodeApi.PEResources/.nuget/README.md
@@ -1,3 +1,13 @@
 # BytecodeApi.PEResources
 
-Library for reading of native resources of executables & DLL files.
+Library for reading of native resources of executables & DLL files.
+
+## Examples
+
+See: [Examples](https://github.com/bytecode77/bytecode-api/blob/master/BytecodeApi.PEResources/README.md)
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.PEResources/README.md b/BytecodeApi.PEResources/README.md
@@ -31,4 +31,10 @@ resourceFile.ChangeIcon(new Icon(@"C:\path\to\icon.ico"));
 // Strip all resources:
 resourceFile.DeleteResources();
 ```
-</details>
+</details>
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.Penetration/.nuget/README.md b/BytecodeApi.Penetration/.nuget/README.md
@@ -1,3 +1,13 @@
 # BytecodeApi.Penetration
 
-Basic implementations of certain penetration testing routines, such as code injection.
+Basic implementations of certain penetration testing routines, such as code injection.
+
+## Examples
+
+See: [Examples](https://github.com/bytecode77/bytecode-api/blob/master/BytecodeApi.Penetration/README.md)
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.Penetration/README.md b/BytecodeApi.Penetration/README.md
@@ -52,4 +52,10 @@ To load and invoke a .NET executable, use `ExecuteDotNetAssembly`:
 byte[] dotNetExecutable = ...;
 ExecutableInjection.ExecuteDotNetAssembly(dotNetExecutable, new[] { "arg1", "arg2" });
 ```
-</details>
+</details>
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.Rest/.nuget/README.md b/BytecodeApi.Rest/.nuget/README.md
@@ -1,3 +1,13 @@
 # BytecodeApi.Rest
 
-Fluent REST client.
+Fluent REST client.
+
+## Examples
+
+See: [Examples](https://github.com/bytecode77/bytecode-api/blob/master/BytecodeApi.Rest/README.md)
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.Rest/README.md b/BytecodeApi.Rest/README.md
@@ -65,4 +65,10 @@ catch (RestException ex)
 }
 ```
 
-</details>
+</details>
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
diff --git a/BytecodeApi.Win32/.nuget/README.md b/BytecodeApi.Win32/.nuget/README.md
@@ -1,3 +1,18 @@
 # BytecodeApi.Win32
 
-Library for querying Windows specific operating system data.
+Library for querying Windows specific operating system data.
+
+## Examples
+
+See: [Examples](https://github.com/bytecode77/bytecode-api/blob/master/BytecodeApi.Win32/README.md)
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
+
+### 3.0.1 (27.09.2023)
+
+* **new:** `HardwareInfo.TotalMemory` and `AvailableMemory`
+* **removed:** `HardwareInfo.Memory`
diff --git a/BytecodeApi.Win32/README.md b/BytecodeApi.Win32/README.md
@@ -196,4 +196,15 @@ foreach(TcpViewEntry entry in tcp.Entries)
 	// ...
 }
 ```
-</details>
+</details>
+
+## Changelog
+
+### 3.0.0 (08.09.2023)
+
+* Initial release
+
+### 3.0.1 (27.09.2023)
+
+* **new:** `HardwareInfo.TotalMemory` and `AvailableMemory`
+* **removed:** `HardwareInfo.Memory`