Readme update (#3)

* readme update

* Update action.yml

Co-Authored-By: Fernando Mayo <[email protected]>

* adds logo

README.md

@@ -1,2 +1,32 @@
-# scope-for-dotnet-gh
-Scope for dotnet GitHub action
+![logo](scope_logo.svg)
+
+# Scope for .NET
+
+GitHub Action to run your tests automatically instrumented with the [Scope .NET agent](https://docs.scope.dev/docs/dotnet-installation).
+
+## About Scope
+
+[Scope](https://scope.dev) gives developers production-level visibility on every test for every app – spanning mobile, monoliths, and microservices.
+
+## Usage
+
+1. Set Scope DSN inside Settings > Secrets as `SCOPE_DSN`.
+2. Add a step to your GitHub Actions workflow YAML that uses this action:
+
+```yml
+steps:
+  - uses: actions/checkout@v1
+  - name: Setup .NET Core
+    uses: actions/setup-dotnet@v1
+    with:
+      dotnet-version: 3.0.100
+  - name: Build with dotnet
+    run: dotnet build
+  - name: Scope for .NET
+    uses: undefinedlabs/scope-for-dotnet-action@v1
+    with:
+      dsn: ${{secrets.SCOPE_DSN}} # required
+      use-solutions: true  # optional - default is 'true'
+      command: dotnet test # optional - default is 'dotnet test'
+
+```

action.yml

@@ -1,12 +1,12 @@
-name: 'scope-for-dotnet'
+name: 'Scope for .NET'
 author: 'Undefined Labs'
-description: 'Scope agent for dotnet'
+description: 'Automatically instruments and runs your tests using the Scope .NET agent'
 inputs:
   command:  # command to run inside the scope-run wrapper
     description: 'Command to run inside the scope-run wrapper'
     required: false
   dsn: # scope dsn
-    description: 'Scope dsn'
+    description: 'Scope DSN'
     required: true
   use-solutions: # use solutions file
     description: 'Run the scope-run command from the solutions file folder'