Merge pull request #27 from nenoNaninu/update_readme

Update readme
nenoNaninu · Nov 14, 2021 · 02f7c8e · 02f7c8e
2 parents 42fdb2b + f8fd257
commit 02f7c8e
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 38 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,6 +1,6 @@
 version: 2
 updates:
-  - package-ecosystem: "nuget" # See documentation for possible values
+  - package-ecosystem: "nuget"
     directory: "/" # Location of package manifests
     schedule:
       interval: "daily"
diff --git a/.github/workflows/build-and-test.yaml b/.github/workflows/build-and-test.yaml
@@ -2,31 +2,32 @@ name: build-and-test
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
   schedule:
-    - cron: '0 0 * * *'
+    - cron: "0 0 * * *"
 
 env:
-  DOTNET_VERSION: '6.0.x' # The .NET SDK version to use
+  DOTNET_VERSION: "6.0.x"
+  DOTNET_NOLOGO: true
 
 jobs:
   build-and-test:
     name: build-and-test
     runs-on: windows-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: ${{ env.DOTNET_VERSION }}
+      - uses: actions/checkout@v2
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: ${{ env.DOTNET_VERSION }}
 
-    - name: Install dependencies
-      run: dotnet restore
-      
-    - name: Build
-      run: dotnet build --configuration Release --no-restore
-    
-    - name: Test
-      run: dotnet test --no-restore --verbosity normal
+      - name: Install dependencies
+        run: dotnet restore
+
+      - name: Build
+        run: dotnet build --configuration Release --no-restore
+
+      - name: Test
+        run: dotnet test --no-restore --verbosity normal
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -5,32 +5,34 @@ on:
     tags:
       - "[0-9]+.[0-9]+.[0-9]+*"
 
+env:
+  DOTNET_VERSION: "6.0.x"
+  DOTNET_NOLOGO: true
+
 jobs:
   release:
     name: release
     runs-on: ubuntu-latest
-    env:
-      DOTNET_NOLOGO: true
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: '6.0.x'
+      - uses: actions/checkout@v2
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: ${{ env.DOTNET_VERSION }}
 
-    - name: "Get version from git tag"
-      run: echo "Version=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+      - name: "Get version from git tag"
+        run: echo "Version=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
 
-    - name: "dotnet build"
-      run: dotnet build -c Release -p:Version=$Version ./HomographySharp/HomographySharp.csproj
+      - name: "dotnet build"
+        run: dotnet build -c Release -p:Version=$Version ./HomographySharp/HomographySharp.csproj
 
-    - name: "dotnet pack"
-      run: dotnet pack -c Release --no-build --include-symbols --output $GITHUB_WORKSPACE/artifacts -p:PackageVersion=$Version ./HomographySharp/HomographySharp.csproj
+      - name: "dotnet pack"
+        run: dotnet pack -c Release --no-build --include-symbols --output $GITHUB_WORKSPACE/artifacts -p:PackageVersion=$Version ./HomographySharp/HomographySharp.csproj
 
-    # Upload artifact
-    - uses: actions/upload-artifact@v2
-      with:
-        name: Packages
-        path: artifacts
+      - uses: actions/upload-artifact@v2
+        with:
+          name: Packages
+          path: artifacts
 
-    - name: "dotnet nuget push"
-      run: dotnet nuget push "$GITHUB_WORKSPACE/artifacts/*.nupkg" --skip-duplicate -k ${{ secrets.NUGET_API_KEY }} -s https://api.nuget.org/v3/index.json
+      - name: "dotnet nuget push"
+        run: dotnet nuget push "$GITHUB_WORKSPACE/artifacts/*.nupkg" --skip-duplicate -k ${{ secrets.NUGET_API_KEY }} -s https://api.nuget.org/v3/index.json
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![build-and-test](https://github.com/nenoNaninu/HomographySharp/actions/workflows/build-and-test.yaml/badge.svg)](https://github.com/nenoNaninu/HomographySharp/actions/workflows/build-and-test.yaml)
 
-HomographySharp is a (C#/.NET Standard2.0 and .NET 5) class library for finding and using homography matrix.
+HomographySharp is a (C#/.NET Standard2.0 and .NET 6) class library for finding and using homography matrix.
 
 # Install
 NuGet: [HomographySharp](https://www.nuget.org/packages/HomographySharp/)