From 76646fd05bc22ad3ea273c3be4315af0ba2e05ad Mon Sep 17 00:00:00 2001 From: The Doctor Date: Thu, 9 Jul 2020 09:36:59 +0100 Subject: [PATCH] Updated README.md --- PMF/src/Managers/LocalPackageManager.cs | 2 +- PMF/src/Package/Dependency.cs | 6 +++- README.md | 38 ++++++++++++++++--------- 3 files changed, 30 insertions(+), 16 deletions(-) diff --git a/PMF/src/Managers/LocalPackageManager.cs b/PMF/src/Managers/LocalPackageManager.cs index 74dd4c1..4fc8c3d 100644 --- a/PMF/src/Managers/LocalPackageManager.cs +++ b/PMF/src/Managers/LocalPackageManager.cs @@ -34,7 +34,7 @@ namespace PMF.Managers var json = JsonConvert.SerializeObject(PackageManager.PackageList); File.WriteAllText(Config.ManifestFileName, json); Directory.Delete(Config.TemporaryFolder, true); - PMF.InvokePackageMessageEvent("Successfully cleaned PMF"); + // PMF.InvokePackageMessageEvent("Successfully cleaned PMF"); } public static void validateManifestFile() diff --git a/PMF/src/Package/Dependency.cs b/PMF/src/Package/Dependency.cs index 9a9b149..9da39b8 100644 --- a/PMF/src/Package/Dependency.cs +++ b/PMF/src/Package/Dependency.cs @@ -1,4 +1,6 @@ -using System; +using Newtonsoft.Json.Converters; +using System; +using System.Text.Json.Serialization; namespace PMF { @@ -20,11 +22,13 @@ namespace PMF /// /// Type of dependency /// + [JsonConverter(typeof(StringEnumConverter))] // This converts enum to string and vice versa when generating or parsing json public DependencyType Type { get; set; } /// /// Version of the dependency if type is Package /// + [JsonConverter(typeof(VersionConverter))] // This ensures the version object is correctly converted public Version Version { get; set; } /// diff --git a/README.md b/README.md index 1356d16..4258b75 100644 --- a/README.md +++ b/README.md @@ -125,22 +125,32 @@ This is the basic information a package would have ```json { "ID": "something_cool", - "Type": 1, + "Type": "Plugin", "Name": "Im Something cool", "Description": "This is a package that makes you cool and awesome", - "Assets": [{ - "Version": "0.0.1", - "SdkVersion": "0.0.5", - "Checksum": "somethingCoolWithLettersAndNumbers", - "FileName": "name.zip", - "Url": "somewhereElseDoesntNeedToBeYourServer.zip", - "Dependencies": [{ - "ID": "Inner Spirit", - "Checksum": "somethingHere", - "FileName": "zipped.zip", - "Url": "somewhereElseDoesntNeedToBeYourServer.zip" - }] - }] + "Assets": [ + { + "Version": "0.0.1", + "SdkVersion": "0.0.5", + "Checksum": "somethingCoolWithLettersAndNumbers", + "FileName": "name.zip", + "Url": "somewhereElseDoesntNeedToBeYourServer.zip", + "Dependencies": [ + { + "ID": "Inner Spirit", + "Checksum": "somethingHere", + "Type": "Standalone", + "FileName": "zipped.zip", + "Url": "somewhereElseDoesntNeedToBeYourServer.zip" + }, + { + "ID": "Other package id", + "Checksum": "somethingHere", + "Type": "Package", + "Version": "0.2.3" + }] + } + ] } ```