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

1. Clone the repo

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

2. Install packages

   npm install

Start the Development Server

1. Run npm run dev to build the library and launch the example app.

2. You should see a window like this open:

   

3. From this window you can scan the qr code with Expo, or launch the iOS or Android simulator.

License

Copyright © 2021 by Pinpoint Software, Inc. Distributed under the MIT License. See LICENSE for more information.