Skip to content

Commit d84a845

Browse files
committed
Bring the README and CI up to org standard
1 parent e02a2ab commit d84a845

3 files changed

Lines changed: 23 additions & 12 deletions

File tree

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,20 @@ on:
44
push:
55
branches: [main]
66
pull_request:
7+
branches: [main]
78

89
jobs:
910
test:
1011
runs-on: ubuntu-latest
1112
steps:
1213
- uses: actions/checkout@v4
1314
- uses: actions/setup-node@v4
14-
with: { node-version: 22 }
15-
- run: npm install
15+
with:
16+
node-version: 22
17+
cache: npm
18+
- run: npm ci
1619
- run: npm run typecheck
20+
- run: npm run lint
1721
# The golden vectors are the contract between every Ripstop SDK. Red here
1822
# means this SDK disagrees with the protocol, not the other way round.
1923
- run: npm test
20-
- run: npm run build

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
1-
# @ripstop/react-native
1+
<p align="center">
2+
<a href="https://ripstop.dev"><img src="https://ripstop.dev/mark.png" width="56" alt="Ripstop"></a>
3+
</p>
24

3-
**Remote config, update walls and maintenance mode for React Native.**
4-
Decided at the edge, verified on device.
5+
<h1 align="center">Ripstop React Native SDK</h1>
56

6-
[![npm](https://img.shields.io/npm/v/@ripstop/react-native.svg)](https://www.npmjs.com/package/@ripstop/react-native)
7-
[![CI](https://github.com/ripstop-dev/ripstop-react-native/actions/workflows/ci.yaml/badge.svg)](https://github.com/ripstop-dev/ripstop-react-native/actions/workflows/ci.yaml)
8-
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
7+
<p align="center">
8+
<a href="https://github.com/ripstop-dev/ripstop-react-native/actions/workflows/ci.yml"><img src="https://github.com/ripstop-dev/ripstop-react-native/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
9+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
10+
</p>
911

10-
## Install
12+
<p align="center"><b>Remote config, update walls and maintenance mode for React Native — decided at the edge, verified on device.</b></p>
13+
14+
## Installation
15+
16+
`@ripstop/react-native` is not on npm yet. Until it is, install straight from
17+
GitHub — the package builds itself on install:
1118

1219
```bash
13-
npm install @ripstop/react-native
20+
npm install github:ripstop-dev/ripstop-react-native
1421
```
1522

1623
No native modules, no pod install, no config plugin. It is JavaScript.
1724

18-
## Quickstart
25+
## Quick start
1926

2027
```tsx
2128
import { RipstopProvider } from '@ripstop/react-native';

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
"files": ["dist", "README.md", "LICENSE"],
1515
"scripts": {
1616
"build": "tsup src/index.tsx --format esm,cjs --dts --clean",
17+
"prepare": "npm run build",
1718
"typecheck": "tsc --noEmit",
1819
"test": "vitest run",
1920
"lint": "eslint ."

0 commit comments

Comments
 (0)