Compare commits

...

2 commits

Author SHA1 Message Date
D. Moonfire 63b59b101e docs: added news post
All checks were successful
deploy / deploy (push) Successful in 10m56s
2024-04-21 14:54:30 -05:00
D. Moonfire a7226db9e9 feat: renamed MfGames.Crypto to MfGames.Cryptography 2024-04-21 12:58:51 -05:00
14 changed files with 42 additions and 26 deletions

View file

@ -95,7 +95,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MfGames.Nitride.Exec.Tests"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MfGames.Cryptography", "src\MfGames.Cryptography\MfGames.Cryptography.csproj", "{832DBBC9-3A53-4F6B-B98C-4059DF780124}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MfGames.Crypto.Tests", "tests\MfGames.Crypto.Tests\MfGames.Crypto.Tests.csproj", "{7A773B2F-ADF4-450F-8F43-D3C3C689E1CE}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MfGames.Cryptography.Tests", "tests\MfGames.Cryptography.Tests\MfGames.Cryptography.Tests.csproj", "{7A773B2F-ADF4-450F-8F43-D3C3C689E1CE}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MfGames.Nitride.SpectreConsole", "src\MfGames.Nitride.SpectreConsole\MfGames.Nitride.SpectreConsole.csproj", "{0C5C8D0A-D283-477F-82C4-2FF026F6EC0C}"
EndProject

View file

@ -6,7 +6,7 @@ This [monorepo](https://en.wikipedia.org/wiki/Monorepo) is the collection of all
The documentation for the entire project can be found in the [./docs/ folder](./docs/index.md) of this project, but below are some notable links are:
- [MfGames.Gallium](./docs/gallium/index.md) - A toy Entity-Component-System (ECS) modeled after LINQ methods calls and suitable for environment where ease of use is more critical than performance.
- [MfGames.Gallium](./docs/gallium/index.md) - A simplified Entity-Component-System (ECS) modeled after LINQ methods calls and suitable for environment where ease of use is more critical than performance.
- [MfGames.Nitride](./docs/nitride/index.md) - A flexible, configuration-as-code, static site generator build on top of MfGames.Gallium.
## Installing Packages

View file

@ -0,0 +1,9 @@
# Online Documentation
When we started Nitride in May 2021, we always intended to convert all our websites to use the new system. Admitedly, we started with the most complex sites because that would iron out the more complex problems we were trying to solve with Nitride. And there were some rather significant patterns to iron out over the years.
But [mfgames.com](/) was one of those lynchpins for the entire migration because if a program or library isn't documented, it can't be ever be done. And we had examples and patterns, but no good place to point someone who might be interested in using Nitride with something narrative instead of "look at the tests" or "look at these examples."
Now we have it. Adding documentation to our `./docs/` folder will automatically show up on the [website](//mfgames.com/mfgames-cil/). That will also open up the ability to write tutorials on how to use the library, news of what is going on that can be subscribed with feed readers (and maybe a mailing list), and generally those little polish things needed to call something "done."
Here is to the next big step.

View file

@ -0,0 +1,7 @@
# Renaming MfGames.Crypto to MfGames.Cryptography
For many years, "crypto" really meant only one thing in the programming world: cryptozoology. No, actually "cryptography." However, with the advent of web3 and cryptocurrencies, the world "crypto" is becoming muddled and no-longer obvious of its purpose.
Recently, [BouncyCastle](https://www.bouncycastle.org/) has gone through a little refactoring themselves after starting with `BouncyCastle` then renaming themselves to `Portable.BouncyCastle` and finally `BouncyCastle.Cryptography`. Overally, we like the final name and it was inspiration for us doing the same.
So, it isn't really marked as a "breaking" change, but `MfGames.Crypto` is being renamed to `MfGames.Cryptography`. And, to avoid the struggle we had with BouncyCastle, the namespace also was changed to reflect that change.

View file

@ -1,4 +1,4 @@
namespace MfGames.Crypto;
namespace MfGames.Cryptography;
public enum ByteStringFormat
{

View file

@ -1,11 +1,11 @@
using MfGames.Crypto.Hashes;
using MfGames.Cryptography.Hashes;
namespace MfGames.Crypto.Extensions;
namespace MfGames.Cryptography.Extensions;
/// <summary>
/// Extension methods on byte arrays.
/// </summary>
public static class CryptoByteArrayExtensions
public static class CryptographyByteArrayExtensions
{
/// <summary>
/// Converts the input into a hash string, such as hex or base64.

View file

@ -1,12 +1,12 @@
using System.Text;
using MfGames.Crypto.Hashes;
using MfGames.Cryptography.Hashes;
namespace MfGames.Crypto.Extensions;
namespace MfGames.Cryptography.Extensions;
/// <summary>
/// Extension methods for generating hashes for strings.
/// </summary>
public static class CryptoStringExtensions
public static class CryptographyStringExtensions
{
/// <summary>
/// Gets the encoded byte array of the given string.

View file

@ -1,4 +1,4 @@
namespace MfGames.Crypto.Hashes;
namespace MfGames.Cryptography.Hashes;
/// <summary>
/// An enumeration of various hash types.

View file

@ -1,6 +1,6 @@
using System.Security.Cryptography;
namespace MfGames.Crypto.Hashes;
namespace MfGames.Cryptography.Hashes;
public static class HashTypeExtensions
{

View file

@ -1,13 +1,13 @@
using MfGames.Crypto;
using MfGames.Crypto.Extensions;
using MfGames.Crypto.Hashes;
using MfGames.Cryptography;
using MfGames.Cryptography.Extensions;
using MfGames.Cryptography.Hashes;
namespace MfGames.IO.Extensions;
/// <summary>
/// Extensions for generating
/// </summary>
public static class CryptoFileInfoExtensions
public static class CryptographyFileInfoExtensions
{
/// <summary>
/// Hashes the given input and returns the results.

View file

@ -1,10 +1,10 @@
using MfGames.Crypto;
using MfGames.Crypto.Extensions;
using MfGames.Crypto.Hashes;
using MfGames.Cryptography;
using MfGames.Cryptography.Extensions;
using MfGames.Cryptography.Hashes;
namespace MfGames.Nitride.Contents;
public static class CryptoContentExtensions
public static class CryptographyContentExtensions
{
/// <summary>
/// Hashes the given input and returns the results.

View file

@ -1,10 +1,10 @@
using MfGames.Crypto.Extensions;
using MfGames.Crypto.Hashes;
using MfGames.Cryptography.Extensions;
using MfGames.Cryptography.Hashes;
using Xunit;
namespace MfGames.Crypto.Tests;
namespace MfGames.Cryptography.Tests;
public class CryptoStringExtensionsTests
public class CryptographyStringExtensionsTests
{
[Fact]
public void PasswordAsBase64Md5()

View file

@ -1,12 +1,12 @@
using System.IO;
using MfGames.Crypto;
using MfGames.Crypto.Hashes;
using MfGames.Cryptography;
using MfGames.Cryptography.Hashes;
using MfGames.IO.Extensions;
using Xunit;
namespace MfGames.IO.Tests;
public class CryptoFileInfoTests
public class CryptographyFileInfoTests
{
[Fact]
public void HashPasswordFileAsLowercaseHexSha256()