Update Readme and some docs (#149)

* rm InstallCommand * Update docs * Update Readme and docs
SkyAPM · Feb 16, 2019 · b8d46b4 · b8d46b4
1 parent 4c25789
commit b8d46b4
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 175 deletions.
diff --git a/README.md b/README.md
@@ -5,10 +5,10 @@ SkyAPM C#/.NET instrument agent
 
 [Apache SkyWalking](https://github.com/apache/incubator-skywalking) is an APM designed for microservices, cloud native and container-based (Docker, K8s, Mesos) architectures. **SkyAPM-dotnet** provides the native support agent in C# and .NETStandard platform, with the helps from Apache SkyWalking committer team.
 
-![](https://img.shields.io/github/issues-raw/skyapm/skyapm-dotnet.svg?style=flat-square)
-![](https://img.shields.io/github/issues-pr-raw/skyapm/skyapm-dotnet.svg?style=flat-square)
-![](https://img.shields.io/github/release/skyapm/skyapm-dotnet.svg?style=flat-square)
-![](https://img.shields.io/gitter/room/openskywalking/lobby.svg?style=flat-square)
+[![issues](https://img.shields.io/github/issues-raw/skyapm/skyapm-dotnet.svg?style=flat-square)](https://github.com/SkyAPM/SkyAPM-dotnet/issues)
+[![pulls](https://img.shields.io/github/issues-pr-raw/skyapm/skyapm-dotnet.svg?style=flat-square)](https://github.com/SkyAPM/SkyAPM-dotnet/pulls)
+[![releases](https://img.shields.io/github/release/skyapm/skyapm-dotnet.svg?style=flat-square)](https://github.com/SkyAPM/SkyAPM-dotnet/releases)
+[![Gitter](https://img.shields.io/gitter/room/openskywalking/lobby.svg?style=flat-square)](https://gitter.im/openskywalking/Lobby)
 [![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=flat-square&label=Follow&logo=twitter)](https://twitter.com/AsfSkyWalking)
 
 ## CI Build Status
@@ -19,13 +19,15 @@ SkyAPM C#/.NET instrument agent
 
 ## Nuget Packages
 
-| Package Name |  Nuget | Myget | Downloads 
+| Package Name |  NuGet | MyGet | Downloads 
 |--------------|  ------- |  ------- |  ---- 
-| SkyAPM.Agent.AspNetCore | ![](https://img.shields.io/nuget/v/SkyAPM.Agent.AspNetCore.svg?style=flat-square) | ![](https://img.shields.io/myget/skyapm-dotnet/v/SkyAPM.Agent.AspNetCore.svg?style=flat-square) | ![](https://img.shields.io/nuget/dt/SkyAPM.Agent.AspNetCore.svg?style=flat-square) 
-| SkyAPM.Agent.AspNet | ![](https://img.shields.io/nuget/v/SkyAPM.Agent.AspNet.svg?style=flat-square) | ![](https://img.shields.io/myget/skyapm-dotnet/v/SkyAPM.Agent.AspNet.svg?style=flat-square) | ![](https://img.shields.io/nuget/dt/SkyAPM.Agent.AspNet.svg?style=flat-square) 
+| SkyAPM.Agent.AspNetCore | [![nuget](https://img.shields.io/nuget/v/SkyAPM.Agent.AspNetCore.svg?style=flat-square)](https://www.nuget.org/packages/SkyAPM.Agent.AspNetCore) | [![myget](https://img.shields.io/myget/skyapm-dotnet/v/SkyAPM.Agent.AspNetCore.svg?style=flat-square)](https://www.myget.org/feed/skyapm-dotnet/package/nuget/SkyAPM.Agent.AspNetCore) | [![stats](https://img.shields.io/nuget/dt/SkyAPM.Agent.AspNetCore.svg?style=flat-square)](https://www.nuget.org/stats/packages/SkyAPM.Agent.AspNetCore?groupby=Version) 
+| SkyAPM.Agent.AspNet | [![nuget](https://img.shields.io/nuget/v/SkyAPM.Agent.AspNet.svg?style=flat-square)](https://www.nuget.org/packages/SkyAPM.Agent.AspNet) | [![myget](https://img.shields.io/myget/skyapm-dotnet/v/SkyAPM.Agent.AspNet.svg?style=flat-square)](https://www.myget.org/feed/skyapm-dotnet/package/nuget/SkyAPM.Agent.AspNet) | [![](https://img.shields.io/nuget/dt/SkyAPM.Agent.AspNet.svg?style=flat-square)](https://www.nuget.org/stats/packages/SkyAPM.Agent.AspNet?groupby=Version)  
+
+> MyGet feed URL https://www.myget.org/F/skyapm-dotnet/api/v3/index.json
 
 # Supported
-- This project currently supports apps targeting netcoreapp2.0/.net framework4.6.1 or higher.
+- This project currently supports apps targeting netcoreapp2.0/netframework4.6.1 or higher.
 - [Supported middlewares, frameworks and libraries.](docs/Supported-list.md)
 
 # Features

diff --git a/docs/skywalking.json.md → docs/skyapm_config.md b/docs/skywalking.json.md → docs/skyapm_config.md
@@ -1,6 +1,6 @@
-# SkyWalking Configuration
+# SkyAPM Config 
 
-# ServiceName
+## ServiceName
 
 Service name displayed.
 
@@ -12,7 +12,7 @@ Sample Configuration Section
 
 ## Logging
 
-SkyWalking Logging Configuration Section
+SkyAPM Logging Configuration Section
 
 1. Level, defalut:Information
 2. FilePath, defalut:logs\\SkyWalking-{Date}.log

diff --git a/docs/skywalking.json.cn.md → docs/skyapm_config_cn.md b/docs/skywalking.json.cn.md → docs/skyapm_config_cn.md
@@ -1,6 +1,6 @@
-# SkyWalking Config 配置说明
+# SkyAPM Config 配置说明
 
-# ServiceName
+## ServiceName
 
 服务名称
 
@@ -14,7 +14,7 @@
 
 ## Logging
 
-SkyWalking日志配置节点
+日志配置节点
 
 1. Level  日志级别
 2. FilePath 日志保存路径

diff --git a/src/SkyApm.Core/InstrumentStartup.cs b/src/SkyApm.Core/InstrumentStartup.cs
@@ -46,29 +46,16 @@ public InstrumentStartup(TracingDiagnosticProcessorObserver observer, IEnumerabl
             foreach (var service in _services)
                 await service.StartAsync(cancellationToken);
             DiagnosticListener.AllListeners.Subscribe(_observer);
-            _logger.Information("Started SkyWalking .NET Core Agent.");
+            _logger.Information("Started SkyAPM .NET Core Agent.");
         }
 
         public async Task StopAsync(CancellationToken cancellationToken = default(CancellationToken))
         {
             foreach (var service in _services)
                 await service.StopAsync(cancellationToken);
-            _logger.Information("Stopped SkyWalking .NET Core Agent.");
+            _logger.Information("Stopped SkyAPM .NET Core Agent.");
             // ReSharper disable once MethodSupportsCancellation
             await Task.Delay(TimeSpan.FromSeconds(2));
         }
-
-        private string Welcome()
-        {
-            var builder = new StringBuilder();
-            builder.AppendLine("Initializing ...");
-            builder.AppendLine();
-            builder.AppendLine("***************************************************************");
-            builder.AppendLine("*                                                             *");
-            builder.AppendLine("*                Welcome to Apache SkyWalking                 *");
-            builder.AppendLine("*                                                             *");
-            builder.AppendLine("***************************************************************");
-            return builder.ToString();
-        }
     }
 }
diff --git a/src/SkyApm.DotNet.CLI/Command/InstallCommand.cs b/src/SkyApm.DotNet.CLI/Command/InstallCommand.cs
diff --git a/src/SkyApm.DotNet.CLI/SkyApm.DotNet.CLI.csproj b/src/SkyApm.DotNet.CLI/SkyApm.DotNet.CLI.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
     <Import Project="..\..\build\common.props" />
 

diff --git a/src/SkyApm.DotNet.CLI/Utils/DirectoryProvider.cs b/src/SkyApm.DotNet.CLI/Utils/DirectoryProvider.cs
@@ -40,7 +40,7 @@ public class DirectoryProvider
             () => Path.Combine("/usr/local/share", "dotnet"),
             () => Path.Combine("/usr/local/share", "dotnet"));
 
-        public string AgentPath => "skywalking.agent.aspnetcore";
+        public string AgentPath => "skyapm.agent.aspnetcore";
 
         public string AdditonalDepsRootDirectory => Path.Combine(DotnetDirectory, "x64", "additionalDeps");