better docs

substrate-system · Dec 22, 2023 · 4bb0f5a · 4bb0f5a
1 parent d86c951
commit 4bb0f5a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/.npmignore b/.npmignore
@@ -5,4 +5,4 @@ test/
 src/
 !index.js
 !dist/*
-*.md
+*.md
diff --git a/HELP.md b/HELP.md
@@ -1,6 +1,6 @@
 # TROUBLE SHOOTING
 
-### Class Name Mangling
+## Class Name Mangling
 
 To avoid class name mangling issues, we recommend using the second parameter in `Tonic.add` method:
 

diff --git a/README.md b/README.md
@@ -20,13 +20,13 @@ A fork of [@socketsupply/tonic](https://github.com/socketsupply/tonic)
 
 Tonic is a low profile component framework for the web. It's one file, less than 3kb gzipped and has no dependencies. It's designed to be used with modern Javascript and is compatible with all modern browsers and built on top of Web Components.
 
-## Installation
+## Install
 
 ```sh
 npm install @nichoth/tonic
 ```
 
-## Usage
+## Use
 
 ```js
 import Tonic from '@nichoth/tonic'
@@ -53,11 +53,11 @@ After adding your Javascript to your HTML, you can use your component anywhere.
 </html>
 ```
 
-# Useful links
+## Useful links
 - [Tonic components](https://github.com/socketsupply/components)
 - [Migration from the early versions of Tonic](./MIGRATION.md)
 - [API](./API.md)
 - [Troubleshooting](./HELP.md)
 
 MIT License
-
+
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,4 +5,4 @@ test/ @@
     src/
     !index.js
     !dist/*
-    *.md
+    *.md