Utilities and UI components for cross-platform React Native apps
docs: fill out usage and contributing guides
Joseph Hale
(Nov 11, 2025, 4:47 PM -0700)
fd309ebc
a88e8a4c
+31
-13
+18
-2
CONTRIBUTING.md
+18
-2
CONTRIBUTING.md
···
1
1
# Contributing
2
2
3
-
Contributions are always welcome, no matter how large or small!
3
+
🙏🙏🙏
4
+
5
+
## Start Here
4
6
5
-
We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the [code of conduct](./CODE_OF_CONDUCT.md).
7
+
If you're here, I'm assuming that you've found this library useful! That's wonderful and it warms my soul 😊.
8
+
9
+
Unlike many libraries, this one is primarily a [_personal library_](https://psas.dev/purely-personal/). It exists to simplify my efforts to maintain various mobile apps including [Binary Clock](https://github.com/thehale/BinaryClock), [Habit Sync for Todoist](https://github.com/thehale/HabitSync-for-Todoist), and [Speedcuber Timer](https://github.com/SpeedcuberOSS/speedcuber-timer). Broad utility is only a goal insofar as it makes my life easier when maintaining my apps.
10
+
11
+
If you choose to offer contributions, please keep in mind the following:
12
+
- I can/will make breaking API changes whenever I want -- this library exists to serve my apps.
13
+
- You, however, cannot change the APIs -- don't break my apps! 🙏
14
+
- Well-written, automated tests are really important to me -- contributions that include good tests are taken much more seriously than those without.
15
+
- Eventually, I want to offer my apps on Windows and MacOS.
16
+
- In general, adding dependencies (particularly native dependencies) is strongly discouraged. Anything Expo\* is strictly prohibited -- don't block my aspirations! 🙏
17
+
- Limit yourself to boring old JavaScript/TypeScript and the [core React Native components and APIs](https://reactnative.dev/docs/components-and-apis). e.g. use [`Animated`](https://reactnative.dev/docs/animated), and [`StyleSheet`](https://reactnative.dev/docs/stylesheet) instead of any third-party library/tool -- don't bloat my apps! 🙏
18
+
19
+
<sub>\* Expo is a great tool for many projects -- including this library's [example app](example/package.json) -- but I prefer the control/flexibility of running bare React Native. Thus this library cannot _depend_ on anything Expo.</sub>
20
+
21
+
Thank you for being considerate of my goals with this library! I look forward to seeing your contributions, be they large or small!
6
22
7
23
## Development workflow
8
24
+13
-11
README.md
+13
-11
README.md
···
1
-
# react-native-expressive
1
+
<div align="center">
2
2
3
+
# React Native Expressive
4
+
5
+
Utilities and UI components for cross-platform React Native apps
3
6
<!-- BADGES -->
7
+
[](https://psas.dev/purely-personal)
4
8
[](https://github.com/thehale/react-native-expressive/blob/master/LICENSE)
5
9
[](https://github.com/sponsors/thehale)
6
10
[](https://jhale.dev)
7
11
[](https://www.linkedin.com/comm/mynetwork/discovery-see-all?usecase=PEOPLE_FOLLOWS&followMember=thehale)
12
+
13
+
14
+
<img src="docs/img/kitchen-sink-ios-dark.png" width=250 />
15
+
<img src="docs/img/kitchen-sink-android-light.png" width=250 />
8
16
9
-
Utilities and UI components for cross-platform React Native apps
17
+
</div>
10
18
11
19
12
20
## Installation
13
21
14
-
15
22
```sh
16
23
npm install react-native-expressive
17
24
```
···
20
27
## Usage
21
28
22
29
23
-
```js
24
-
import { multiply } from 'react-native-expressive';
25
-
26
-
// ...
27
-
28
-
const result = await multiply(3, 7);
29
-
```
30
+
See the [example app](example/src/App.tsx)
30
31
31
32
32
33
## Contributing
33
34
35
+
- [👀 START HERE!](CONTRIBUTING.md#start-here)
34
36
- [Development workflow](CONTRIBUTING.md#development-workflow)
35
37
- [Sending a pull request](CONTRIBUTING.md#sending-a-pull-request)
36
38
- [Code of conduct](CODE_OF_CONDUCT.md)
37
39
38
40
## License
39
-
Copyright (c) 2022-2024 Joseph Hale, All Rights Reserved
41
+
Copyright (c) 2025 Joseph Hale, All Rights Reserved
40
42
41
43
Provided under the terms of the [Mozilla Public License, version 2.0](./LICENSE)
42
44
docs/img/kitchen-sink-android-light.png
docs/img/kitchen-sink-android-light.png
This is a binary file and will not be displayed.
docs/img/kitchen-sink-ios-dark.png
docs/img/kitchen-sink-ios-dark.png
This is a binary file and will not be displayed.