Skip to content

Commit 11bfd12

Browse files
authored
Update README.md
1 parent aed4936 commit 11bfd12

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1-
# SpringLoader
1+
# 🌈 SpringLoader [![npm version](https://badge.fury.io/js/spring-loader.svg)](https://badge.fury.io/js/spring-loader)
22

3-
Gradient spring animated loading activity indicator component for React Native
3+
Gradient spring animated loading activity indicator component for React Native.
4+
5+
The animation is created in pure [reanimated2](https://docs.swmansion.com/react-native-reanimated/) and [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG).
6+
7+
It's lightweight, made in TypeScript, and can be used in the Splash screen (unlike Lottie and Rove animations).
8+
9+
## Showcase
10+
11+
![alt Showcase](https://github.com/geekbrother/SpringLoader/blob/main/assets/showcase.gif)
12+
13+
## How to use
14+
15+
The package uses TypeScript and provides types when importing.
16+
17+
Add package to the React Native project by `npm i spring-loader`.
18+
19+
Import the `SpringLoader` component `import { AnimationTypes, SpringLoader } from 'spring-loader';`.
20+
21+
Find a full usage example in [examples/expo-app/App.tsx](https://github.com/geekbrother/SpringLoader/blob/main/examples/expo-app/App.tsx).
22+
23+
## Todo
24+
25+
Implement a [Skia](https://github.com/Shopify/react-native-skia) version

0 commit comments

Comments
 (0)