improved documentation

skartknet · Mar 24, 2023 · e68944c · e68944c
1 parent 5f9317f
commit e68944c
Show file tree

Hide file tree

Showing 16 changed files with 17 additions and 16 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -14,7 +14,7 @@ jobs:
   publish-nuget:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Get Release Version
       id: package_version
@@ -54,9 +54,9 @@ jobs:
     - name: Create Nuget Packages
       run: dotnet pack --configuration Release -o  ${{ env.OUTPUT_PATH }}
 
-    - name: Publish to NuGet
-      working-directory: ${{ env.OUTPUT_PATH }}
-      run: dotnet nuget push *.nupkg --skip-duplicate --api-key ${{ secrets.NUGET_API_KEY }} -s https://api.nuget.org/v3/index.json
+    # - name: Publish to NuGet
+    #   working-directory: ${{ env.OUTPUT_PATH }}
+    #   run: dotnet nuget push *.nupkg --skip-duplicate --api-key ${{ secrets.NUGET_API_KEY }} -s https://api.nuget.org/v3/index.json
 
     - uses: avakar/tag-and-release@v1
       name: Create Release Tag v${{ steps.package_version.outputs.version }}

diff --git a/Documentation/Configuration/addPreConfig.png b/Documentation/Configuration/addPreConfig.png
diff --git a/Documentation/Configuration/configDetails.png b/Documentation/Configuration/configDetails.png
diff --git a/Documentation/Configuration/datatype.png b/Documentation/Configuration/datatype.png
diff --git a/Documentation/select-editor.png → Documentation/Usage/select-editor.png b/Documentation/select-editor.png → Documentation/Usage/select-editor.png
diff --git a/Documentation/using-iconic.png → Documentation/Usage/using-iconic.png b/Documentation/using-iconic.png → Documentation/Usage/using-iconic.png
diff --git a/Documentation/addPackage2.png b/Documentation/addPackage2.png
diff --git a/Documentation/addPreConfig.png b/Documentation/addPreConfig.png
diff --git a/Documentation/configDetails.png b/Documentation/configDetails.png
diff --git a/Documentation/datatype.png b/Documentation/datatype.png
diff --git a/Documentation/v8-1.png b/Documentation/v8-1.png
diff --git a/Documentation/v8-2.png b/Documentation/v8-2.png
diff --git a/Our.Iconic/Our.Iconic.csproj b/Our.Iconic/Our.Iconic.csproj
@@ -12,7 +12,7 @@
 	</Description>
 	<Product>$(AssemblyName)</Product>
 	<PackageTags>umbraco plugin package icon picker editor backoffice umbraco-marketplace</PackageTags>
-	<Version>5.2.1</Version>
+	<Version>5.2.2</Version>
 	<Authors>Mario Lopez</Authors>
 	<PackageProjectUrl>https://github.com/Skartknet/Iconic</PackageProjectUrl>
 	<PackageIcon>iconic_logo.png</PackageIcon>

diff --git a/README.nuget.md b/README.nuget.md
@@ -12,8 +12,8 @@ Version 5 is no longer multi-targeted. Only supports .NET 6 and Umbraco > 10.2.0
 
 Previous versions of this package are on https://github.com/KOBENDigital/Iconic
 
-### Umbraco Package
-https://our.umbraco.com/packages/backoffice-extensions/iconic/
+### Umbraco Marketplace
+https://marketplace.umbraco.com/package/our.iconic
 
 ---
 

diff --git a/README.md → umbraco-marketplace-readme.md b/README.md → umbraco-marketplace-readme.md
@@ -1,5 +1,5 @@
 # Iconic
-Highly configurable icon picker for Umbraco.
+Iconic is a highly configurable package that allows you to easily add icon libraries to your Umbraco content.
 
 ## Introduction
 With Iconic you will be able to create a property editor that can use virtually any font package out there and not only that, you will  be able to select your icon from more than one package on the same property.
@@ -25,12 +25,6 @@ If you are upgrading from previous Iconic versions, follow these steps (you shou
 ### Nuget
 [![NuGet](https://buildstats.info/nuget/Our.Iconic)](https://www.nuget.org/packages/Our.Iconic/)
 
-You can run the following command from within Visual Studio:
-
-    PM> Install-Package Our.Iconic
-
-### Umbraco Package
-https://our.umbraco.com/packages/backoffice-extensions/iconic/
 
 
 ## Configuration
@@ -45,4 +39,4 @@ Username: `[email protected]`\
 Password: `Password123`
 
 
-Handmade by Mario Lopez - 2022 @skartknet
+Handmade by Mario Lopez - 2023 @skartknet
diff --git a/umbraco-marketplace.json b/umbraco-marketplace.json
@@ -32,10 +32,17 @@
     },
     "Category": "Editor Tools",
     "DiscussionForumUrl": "https://our.umbraco.com/packages/backoffice-extensions/iconic",
+    "DocumentationUrl": "https://github.com/skartknet/Iconic/tree/master/Documentation",
     "LicenseTypes": ["Free"],
     "PackageType": "Package",
     "Title": "Iconic",
     "PackagesByAuthor": ["Our.Umbraco.ConditionalDisplayers"],
     "Tags":["icons", "icon", "fontawesome", "font awesome"],
-    "Description": "Iconic is a highly configurable package that allows you to easily add icon libraries to your Umbraco content."
+    "Description": "Iconic is a highly configurable package that allows you to easily add icon libraries to your Umbraco content.",
+    "Screenshots": [
+        {
+          "ImageUrl": "",
+          "Caption": ""
+        }
+      ]
 }