📝 Added logo and settings documentation (#72)

docs/Writerside/topics/Default-topic.md

@@ -1 +1,21 @@
 # uActivityPub
+
+[![NuGet Version](http://img.shields.io/nuget/v/uActivityPub.svg?style=flat)](https://www.nuget.org/packages/uActivityPub/) [![NuGet Downloads](https://img.shields.io/nuget/dt/uActivityPub.svg)](https://www.nuget.org/packages/uActivityPub/) [![GitHub License](https://img.shields.io/github/license/eduwardpost/uActivityPub)](https://github.com/eduwardpost/uActivityPub)
+
+![uActivityPub](uActivityPub.svg)
+
+
+This package allows you to hook your umbraco website into the fediverse.
+
+Currently the settings or only settable in the database, you can however view them in the umbraco backoffice
+The current roadmap is to extend this package with some settings, then harden it for edge cases.
+
+
+## How to use this package
+
+1. Install the nuget package to your umbraco (v13) project.
+2. Have a content type with the alias `article`
+3. In that content type have a property with the alias `authorName` which is a user selector that is mandatory
+    - The package uses the user selector to create/read the settings for said user and creates the required table entries so that it can be followed
+    - Or it can be configured with a few settings in the database to change its behavior. See [Settings](Settings.md) for more information.
+4. Publish article on your site

docs/Writerside/topics/Settings.md

@@ -0,0 +1,69 @@
+# Settings
+
+the uActivityPub package can be configured to change its behavior with a few settings.
+
+## How to change the settings
+
+Currently, settings are read only visable on the umbraco backoffice user interface. 
+Under the settings main tab there will be a new entry in the left menu tree called `uActivityPub`
+Here you can see the current values of the settings.
+
+Settings are stored in the same SQL database as the umbraco website. And can currently only be changed directly on the SQL database.
+The settings are stored in the table `[uActivitySettings]` of the schema you installed umbraco in (default `[dbo]`) 
+
+All setting values are a string tha get parsed runtime to a value
+
+## Supported settings
+
+### Single user mode {id=singleUserMode}
+
+> supported values:
+> - true
+> - false
+
+_default value:_ __false__
+
+This setting sets the package in either single user mode or multi user mode.
+
+In single user mode the package uses the [Single user mode username](#singleUserModeUserName) setting to determine which user to respond to.
+
+In multi user mode it uses the umbraco User database (not members) to decide which users to respond to. 
+
+### Single user mode username {id=singleUserModeUserName}
+
+> supported values:
+> - any url safe string
+
+_default value:_ __uActivityPub__
+
+This setting is used to determine the actor username in [single user mode](#singleUserMode).
+
+### Content type alias
+
+> supported values:
+> - any umbraco content type alias
+
+_default value:_ __article__
+
+This setting is used to determine which content type to monitor and post about into the Fediverse.
+Currently only one content type at the time is supported.
+
+### List content type alias
+
+> supported values:
+> - any umbraco content type alias
+
+_default value:_ __articleList__
+
+This setting is used to determine which content list type to use for post count calculation.
+Currently only one content type at the time is supported.
+
+### Author name alias
+
+> supported values:
+> - any umbraco property type alias that exists on the chosen content type
+
+_default value:_ __authorName__
+
+This setting is used to determine who the user is of an article. This setting is only used in [multiuser](#singleUserMode) mode.
+The alias should point to a property of the type: `Umbraco.UserPicker`. This property does not have to exist in [single user mode](#singleUserMode).

docs/Writerside/u.tree

@@ -6,5 +6,7 @@
                  name="uActivityPub"
                  start-page="Default-topic.md">
 
-    <toc-element topic="Default-topic.md"/>
+    <toc-element topic="Default-topic.md">
+        <toc-element topic="Settings.md"/>
+    </toc-element>
 </instance-profile>

src/uActivityPub/uActivityPub.csproj

@@ -17,14 +17,16 @@
         <Authors>Eduward Post</Authors>
         <Description>A umbraco package user to make your installation interface with the fediverse</Description>
         <RepositoryUrl>https://github.com/eduwardpost/uActivityPub.git</RepositoryUrl>
+        <RepositoryUrl>https://github.com/eduwardpost/uActivityPub</RepositoryUrl>
         <RepositoryType>git</RepositoryType>
         <PackageTags>library, umbraco, umbraco-marketplace, fediverse</PackageTags>
         <PackageLicenseExpression>GPL-3.0-only</PackageLicenseExpression>
         <PackageReadmeFile>README.md</PackageReadmeFile>
+        <PackageIcon>uActivityPub-icon.png</PackageIcon>
         <Product>uActivityPub</Product>
         <PackageId>uActivityPub</PackageId>
-        <Version>1.0.16</Version>
-        <AssemblyVersion>1.0.16</AssemblyVersion>
+        <Version>1.0.17</Version>
+        <AssemblyVersion>1.0.17</AssemblyVersion>
     </PropertyGroup>
 
     <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
@@ -33,6 +35,7 @@
 
     <ItemGroup>
         <None Include="..\..\README.md" Pack="true" PackagePath="\"/>
+        <None Include="..\..\docs\Writerside\images\uActivityPub-icon.png" Pack="true" PackagePath="\"/>
     </ItemGroup>
 
     <ItemGroup>