Merge pull request #3 from keik/doc2

📝 Update README.
keik · Sep 26, 2021 · 66392b1 · 66392b1
2 parents 67a5ce5 + 6102511
commit 66392b1
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,5 @@
 /Gemfile.local
 /Gemfile.lock
 /coverage
+/pkg
 /vendor
diff --git a/README.md b/README.md
@@ -24,22 +24,22 @@ require: rubocop-dependency
 
 ## Cops
 
-Dependency/OverBoundary
+### Dependency/OverBoundary
 
 Check not to refer constants over dependency boundaries which given from `Rules` config.
 
 When the following `Rules` is given,
 
-```
-Rules:                      // Array of each rules
-  - BannedConsts: Foo       // Array<String> | String. Ba
-    FromNamespacePatterns:  // Array<String> | String. This value is used as Regexp pattern
+```yaml
+Rules:                      # Array of each rules
+  - BannedConsts: Foo       # Array<String> | String.
+    FromNamespacePatterns:  # Array<String> | String. This value is used as Regexp pattern.
       - \ABar(\W|\z)
 ```
 
 The following code is considered problems.
 
-```
+```ruby
 class Bar
   Foo
   ^^^ Const `Foo` cannot use from namespace `Bar`.