Skip to content

Commit a8d1d94

Browse files
committed
docs: update README to enhance API documentation section and rename sample projects
1 parent 1087275 commit a8d1d94

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ This SDK helps you integrate your React Native-based iOS and Android apps with
1111
Iterable. It supports JavaScript and TypeScript.
1212

1313

14+
1415
<!-- @import "[TOC]" {cmd="toc" depthFrom=2 depthTo=6 orderedList=false} -->
1516

1617
<!-- code_chunk_output -->
@@ -20,7 +21,8 @@ Iterable. It supports JavaScript and TypeScript.
2021
- [Architecture Support](#architecture-support)
2122
- [Installation](#installation)
2223
- [Features](#features)
23-
- [Sample projects](#sample-projects)
24+
- [📚 API Documentation](#-api-documentation)
25+
- [Example project](#example-project)
2426
- [Version mapping](#version-mapping)
2527
- [Release notes, support and troubleshooting](#release-notes-support-and-troubleshooting)
2628
- [License](#license)
@@ -79,7 +81,11 @@ To learn more about the SDK, read:
7981
- [In-App Messages](https://support.iterable.com/hc/articles/360045714172)
8082
- [Migrating to Iterable's React Native SDK](https://support.iterable.com/hc/articles/360046134931)
8183

82-
## Sample projects
84+
## 📚 API Documentation
85+
86+
View the complete API documentation at [https://iterable-react-native-sdk.netlify.app](https://iterable-react-native-sdk.netlify.app)
87+
88+
## Example project
8389

8490
For sample code, take a look at the following project:
8591

0 commit comments

Comments
 (0)