Skip to content
This repository was archived by the owner on Apr 7, 2024. It is now read-only.

Commit 618389f

Browse files
committed
Start working on basic usage section
1 parent 70f63d8 commit 618389f

File tree

1 file changed

+36
-6
lines changed

1 file changed

+36
-6
lines changed

README.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,23 @@
66

77
# React Native Smart Graph
88

9-
## Dynamic Graph Visualization for React Native
9+
### Dynamic Graph Visualization for React Native
1010

11-
### Effortlessly create and interact with graph structures in your apps
11+
#### Effortlessly create and interact with graph structures in your apps
12+
13+
![npm](https://img.shields.io/npm/dw/react-native-smart-graph?color=ffd53e)
14+
![GitHub issues](https://img.shields.io/github/issues/MatiPl01/react-native-smart-graph?color=ffd53e)
15+
![GitHub contributors](https://img.shields.io/github/contributors/MatiPl01/react-native-smart-graph?color=ffd53e)
16+
![GitHub Release Date](https://img.shields.io/github/release-date/MatiPl01/react-native-smart-graph?color=ffd53e)
17+
![GitHub](https://img.shields.io/github/license/MatiPl01/react-native-smart-graph?color=ffd53e)
18+
19+
![GitHub forks](https://img.shields.io/github/forks/MatiPl01/react-native-smart-graph?style=social)
20+
![GitHub Repo stars](https://img.shields.io/github/stars/MatiPl01/react-native-smart-graph?style=social)
21+
![GitHub watchers](https://img.shields.io/github/watchers/MatiPl01/react-native-smart-graph?style=social)
1222

1323
</div>
1424

1525
<!-- TABLE OF CONTENTS -->
16-
<br>
1726
<h3>
1827
<details>
1928
<summary>
@@ -22,20 +31,33 @@
2231
<h5>
2332
<ol>
2433
<li>
25-
<a href="#getting-started">Getting Started</a>
34+
<p>
35+
<a href="#getting-started">Getting Started</a>
36+
</p>
2637
<ul>
2738
<li><a href="#prerequisites">Prerequisites</a></li>
2839
<li><a href="#installation">Installation</a></li>
2940
</ul>
3041
</li>
42+
<li>
43+
<p>
44+
<a href="#usage">Usage</a>
45+
<ul>
46+
<li><a href="#basic-usage">Basic usage</a></li>
47+
<li><a href="#graph-models">Graph models</a></li>
48+
<li><a href="#graph-components">Graph components</a></li>
49+
<li><a href="#custom-renderers">Creating custom renderers</a></li>
50+
<li><a href="#animations">Creating graph animations</a></li>
51+
</ul>
52+
</p>
53+
</li>
3154
</ol>
3255
</h5>
3356
</details>
3457
</h3>
3558

3659
<!-- GETTING STARTED -->
37-
38-
## 📋 Getting Started
60+
<h2 id="getting-started">⚙ Getting Started</h2>
3961

4062
### Prerequisites
4163

@@ -80,6 +102,8 @@ Before running the app on the iOS device, you will have to take one more step an
80102
npx pod-install ios
81103
```
82104

105+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
106+
83107
### Installation
84108

85109
In order to install the library, you will need to run one of the following commands, depending on the package manager you use in your project. All required dependencies will be automatically installed.
@@ -97,3 +121,9 @@ npm i react-native-smart-graph
97121
```
98122

99123
<p align="right">(<a href="#readme-top">back to top</a>)</p>
124+
125+
<!-- BASIC USAGE -->
126+
<!-- TODO -->
127+
<h2 id="basic-usage">🤹 Basic Usage</h2>
128+
129+
<p align="right">(<a href="#readme-top">back to top</a>)</p>

0 commit comments

Comments
 (0)