Add readme file, fix minor issue with pipeline

LichessTournamentAggregator.App/LichessTournamentAggregator.App.csproj

@@ -6,7 +6,7 @@
     <RuntimeIdentifiers>win-x64;win-x86;linux-x64;osx-x64</RuntimeIdentifiers>
     <PublishSingleFile>true</PublishSingleFile>
     <PublishTrimmed>true</PublishTrimmed>
-    <Version>0.1.0</Version>
+    <Version>0.1.1</Version>
     <Authors>Eduardo Cáceres</Authors>
     <Description>
       Multiplatform desktop app that allows you to aggregate the results of multiple Lichess tournaments

LichessTournamentAggregator/LichessTournamentAggregator.csproj

@@ -7,7 +7,7 @@
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <Title>LichessTournamentAggregator</Title>
     <PackageId>LichessTournamentAggregator</PackageId>
-    <Version>0.1.0</Version>
+    <Version>0.1.1</Version>
     <PackageTags>Chess, Lichess, Tournament, Aggregator</PackageTags>
     <Tags>$(PackageTags)</Tags>
     <Authors>Eduardo Cáceres</Authors>

README.md

@@ -0,0 +1,54 @@
+# Lichess Tournament Aggregator
+
+[![Azure DevOps][azuredevopslogo]][azuredevopslink]
+[![Nuget][nugetlogo]][nugetlink]
+
+[azuredevopslogo]: https://dev.azure.com/eduherminio/LichessTournamentAggregator/_apis/build/status/eduherminio.LichessTournamentAggregator?branchName=master
+[azuredevopslink]: https://dev.azure.com/eduherminio/LichessTournamentAggregator/_build/latest?definitionId=1&branchName=master
+[nugetlogo]: https://img.shields.io/nuget/v/LichessTournamentAggregator.svg?style=flat-square&label=nuget
+[nugetlink]: https://www.nuget.org/packages/LichessTournamentAggregator
+
+**Lichess Tournament Aggregator** is a simple command line application that uses [Lichess API](https://github.com/lichess-org/api) to aggregate the results of multiple tournaments and write them to a `.csv` file.
+
+It's also available as a NuGet package.
+
+## Usage
+
+Binaries for different operating systems can be found [here](https://github.com/eduherminio/LichessTournamentAggregator/releases).
+
+- Download the appropiated version.
+- Run the executable.
+- Enter the tournament urls or ids whose results you want to aggregate (one per line).
+- Press double `enter` to start the process.
+- If the process has concluded successfully, you should see a `.csv` file placed in the same folder as the executable.
+- You can import that `.csv` file from Excel, Google Docs, OpenOffice or your favourite spreadsheet application. Please bear in mind that `;` is the separator you must select if you're given that option.
+
+Alternatively, tournament urls or ids can be passed to the executable as parameters, i.e.:
+
+```bash
+LichessTournamentAggregator-win-x64.exe 2nu1SO6E https://lichess.org/tournament/8ThpFhld 4R6nkdnI
+```
+
+## FAQs
+
+> For which operating systems is the tool available?
+
+It's currently available for **Windows** (10, 8.1 and 7, for both 32 and 64 bits), **Linux** (Ubuntu, CentOS, Debian, Fedora and derivatives) and **macOS** (macOS 10.12 Sierra and above). If you happen to use another operating system, another architecture (arm) or an older version of macOS, please open an [issue](https://github.com/eduherminio/LichessTournamentAggregator/issues) and I'll be happy to try to help.
+
+> I'm a Windows user. How do I know which version to use?
+
+You can check that in `System Information` -> `System type`. Although if you use a reasonably new computer, it's probably going to be x64.
+
+> I've introduced the tournament urls/ids and nothing's happenning...
+
+Try pressing enter again. If it still doesn't work and you get no further any other messages in the console, please fill an [issue](https://github.com/eduherminio/LichessTournamentAggregator/issues) and I'll do my best to help you.
+
+> I've imported the `*.csv` file and the format seems wrong :(
+
+Please make sure to select `;` as separator when importing the file.
+
+> The clasification isn't ordered.
+
+This program won't order the stats of the different players following any specific criteria, you should do that yourself using your spreadsheet editor.
+
+Feel free to contact or or fill an [issue](https://github.com/eduherminio/LichessTournamentAggregator/issues) if you're struggling to use the application or the NuGet package in any way, I'm always happy to help 😉

azure-pipelines.yml

@@ -94,7 +94,7 @@ stages:
       displayName: 'Generate executable for $(Windowsx86)'
       inputs:
         command: 'publish'
-        arguments: '--configuration Release --runtime $(Windowsx86) --output $(Build.SourcesDirectory)/LichessTournamentAggregator/Artifacts/$(Windowsx64)'
+        arguments: '--configuration Release --runtime $(Windowsx86) --output $(Build.SourcesDirectory)/LichessTournamentAggregator/Artifacts/$(Windowsx86)'
         configuration: '$(BuildConfiguration)'
         projects: '**/*.App.csproj'
         modifyOutputPath: false