README

React Native Changelog

The project is the React Native integration for changelogs built using https://changelog.so.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

Usage
1. Installing
2. API
  1. Props
Developing
1. Getting Started
2. Start the Development Server
License

Usage

Installing

npm install @pinpt/react-native-changelog

API

Simply include the component and pass in your changelog's slug:

import * as React from 'react';
import { SafeAreaView } from 'react-native';
import Changelog from '@pinpt/react-native-changelog';

export default function App() {
    return (
        <SafeAreaView>
            <Changelog slug="your-changelog-slug" />
        </SafeAreaView>
    );
}

Props

Name	Required	Type	Description
theme	no	'dark' \| 'light'	Indicates whether to use the dark or light theme. Defaults to dark.
slug	yes	String	The slug for the changelog to display

Developing

This repo includes an example app that can be run in order to develop in an isolated environment.

Getting Started

Clone the repo

git clone https://github.com/pinpt/react-native-changelog.git

Install packages
```
npm install
```

Start the Development Server

Run npm run dev to build the library and launch the example app.
You should see a window like this open:
From this window you can scan the qr code with Expo, or launch the iOS or Android simulator.

Usage no npm install needed!