Skip to content

Commit

Permalink
📝 Docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dominicstop committed Sep 21, 2024
1 parent 1e45c79 commit dc6d33f
Showing 1 changed file with 11 additions and 23 deletions.
34 changes: 11 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,19 @@
# react-native-ios-modal

TBA
## 🚧⚠️ Re-Write in Progress ⚠️🚧

## Installation
hello, this library is being re-written — please see the [`v2.x`](https://github.com/dominicstop/react-native-ios-modal/tree/v2.x) branch for the older version of this library + it's corresponding documentation.

```sh
npm install react-native-ios-modal
```

## Usage
* Support for iOS 15 sheet detents, and iOS 16 custom detents (+ all the related sheet-related customizations and events).
* Typescript re-write for better auto-complete.
* Streamlining the modal-related events, and exposing more events.
* Better iPad support.
* Etc.

```js
import { IosModalView } from "react-native-ios-modal";
<br><br>

// ...
Try out the wip version of the library:

<IosModalView color="tomato" />
```

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

MIT

---

Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
npm install react-native-ios-modal@next
```

0 comments on commit dc6d33f

Please sign in to comment.