From 44fd3eb0a4953b55bdbe698098640b56caa01efd Mon Sep 17 00:00:00 2001 From: Alex Barney Date: Mon, 14 Jun 2021 23:37:37 -0700 Subject: [PATCH] Update package metadata and readme Changes the description of the project to better reflect what it does --- KEYS.md | 4 ++-- README.md | 8 ++++++-- src/LibHac/LibHac.csproj | 3 +-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/KEYS.md b/KEYS.md index 4a298cb5..7243f679 100644 --- a/KEYS.md +++ b/KEYS.md @@ -83,9 +83,9 @@ Erista (original Switch hardware version) and Mariko (second hardware version) h Both these root keys are used to derive the same master key which will then derive other keys. The current root key for Erista is `tsec_root_key_02`, and the key for Mariko is `mariko_kek`. -The main purpose of these keys is to generate the master key, so they're not really necessary for decrypting content. +The main purpose of these keys is to generate the master key, so they're not strictly necessary for decrypting content if you have the latest master key. -These root keys, with proper security, are supposed to be hardware secrets, unable to be accessed by software. +These root keys, with proper security, are supposed to be hardware secrets unable to be accessed by software. Package1 is the only content that is not encrypted with these root keys or their derivatives. Each Erista package1 is encrypted with its own unique key, and every Mariko package1 is encrypted with `mariko_bek`. diff --git a/README.md b/README.md index 99caf328..7c099463 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ [![MyGet](https://img.shields.io/myget/libhac/vpre/libhac.svg?label=myget&style=flat-square)](https://www.myget.org/feed/libhac/package/nuget/LibHac) [![AppVeyor Build Status](https://img.shields.io/appveyor/ci/thealexbarney/LibHac/master.svg?style=flat-square)](https://ci.appveyor.com/project/Thealexbarney/libhac/history) -LibHac is a .NET and .NET Core library for opening, decrypting and extracting common content file formats used by the Nintendo Switch. +LibHac is a .NET library that reimplements some parts of the Nintendo Switch operating system, also known as Horizon OS. + +One of the other main functions of the library is opening, decrypting and extracting common content file formats used by Horizon. Most content is imported and exported using a standard `IStorage` interface. This means that reading nested file types and encryptions can easily be done by linking different file readers together. For example, the files from a title stored on the external SD card can be read or extracted in this way. @@ -12,7 +14,9 @@ For example, the files from a title stored on the external SD card can be read o ## Getting Started -[Library Overview and Samples](docs/getting-started.md) +[Handling Content Files](docs/getting-started.md) + +Todo: Document usage of the `Horizon` and `HorizonClient` objects. # hactoolnet diff --git a/src/LibHac/LibHac.csproj b/src/LibHac/LibHac.csproj index 93296fdf..55974281 100644 --- a/src/LibHac/LibHac.csproj +++ b/src/LibHac/LibHac.csproj @@ -10,8 +10,7 @@ Alex Barney Copyright © 2018-2021 Alex Barney - A library for reading content formats used by the Nintendo Switch. - Nintendo;Switch;nca;xci;savefile + A library that reimplements select portions of the Nintendo Switch operating system and allows reading content formats used by the OS. https://github.com/Thealexbarney/LibHac MIT