Merge branch 'master' of https://github.com/onukura/gitbucket-embedding-plugin

Author: onukura

README.md

@@ -1,8 +1,8 @@
 # gitbucket-embedding-plugin
 
-A GitBucket plugin to replace code link to snippet
+A GitBucket plugin to replace code link to embed snippet.
 
-This is still alpha ver.
+**To achieve embed snippet, this plugin is not best way. It should be done by GitBucket itself. Until the day GitBucket get this feature, this plugin could be a one of choices.**
 
 ## Screenshot
 
@@ -33,18 +33,28 @@ for deployment.
 
 ## Supported link type
 
-`http(s)://host/{owner}/{repository}/blob/{SHA}/{filename}#L{StartLineNumber}-L{EndLineNumber}`
+```
+Links Style:
+http(s)://{host_with_or_without_prefix}/{owner}/{repository}/blob/{SHA}/{path/to/file}#L{StartLineNumber}-L{EndLineNumber}
 
-example1: `http://localhost:8080/root/gitbucket/blob/19f0431a3fb4a9c3560dbf9b1d74f2073da7708f/GitBucketCoreModuleSpec.scala#L5-L10`
+Example1: 
+http://localhost:8080/root/gitbucket/blob/19f0431a3fb4a9c3560dbf9b1d74f2073da7708f/GitBucketCoreModuleSpec.scala#L5-L10
 
-example2: `http://localhost/root/gitbucket/blob/19f0431a3fb4a9c3560dbf9b1d74f2073da7708f/GitBucketCoreModuleSpec.scala#L5-L10`
+Example2: 
+http://localhost/root/gitbucket/blob/19f0431a3fb4a9c3560dbf9b1d74f2073da7708f/src/main/scala/GitBucketCoreModuleSpec.scala#L5-L10
+```
 
 ## Note
 
-you better use link with sha, not branch name such as `master`. Because `master` changes by commits.
+Please use link with sha, not branch name such as `master`. Because `master` changes by commits.
 
-- Good url:  `http://localhost:8080/root/gitbucket/blob/19f0431a3fb4a9c3560dbf9b1d74f2073da7708f/GitBucketCoreModuleSpec.scala#L5-L10`
-- Bad url: `http://localhost:8080/root/gitbucket/blob/master/GitBucketCoreModuleSpec.scala#L5-L10`
+```
+Good url:
+http://localhost:8080/root/gitbucket/blob/19f0431a3fb4a9c3560dbf9b1d74f2073da7708f/GitBucketCoreModuleSpec.scala#L5-L10
+
+No Good url:
+http://localhost:8080/root/gitbucket/blob/master/GitBucketCoreModuleSpec.scala#L5-L10
+```
 
 ## Limitation