Skip to content

Commit

Permalink
docs(README): adjust links to docs.page
Browse files Browse the repository at this point in the history 
we will likely get the notifee.app custom url pointed there again
shortly, but let's have live links in the meantime
  • Loading branch information
@mikehardy
mikehardy committed Dec 17, 2024
1 parent b5d29c0 commit 5f5b301
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

A feature rich Android & iOS notifications library for React Native.

[> Learn More](https://notifee.app/)
[> Learn More](https://docs.page/invertase/notifee/)

---

Expand All @@ -26,36 +26,36 @@ A feature rich Android & iOS notifications library for React Native.

## Documentation

- [Overview](https://notifee.app/react-native/docs/overview)
- [Reference](https://notifee.app/react-native/reference)
- [Overview](https://docs.page/invertase/notifee/react-native/overview)
- [Reference](https://docs.page/invertase/notifee/react-native/reference)

### Android

The APIs for Android allow for creating rich, styled and highly interactive notifications. Below you'll find guides that cover the supported Android features.

| Topic | |
| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| [Appearance](https://notifee.app/react-native/docs/android/appearance) | Change the appearance of a notification; icons, colors, visibility etc. |
| [Behaviour](https://notifee.app/react-native/docs/android/behaviour) | Customize how a notification behaves when it is delivered to a device; sound, vibration, lights etc. |
| [Channels & Groups](https://notifee.app/react-native/docs/android/channels) | Organize your notifications into channels & groups to allow users to control how notifications are handled on their device |
| [Foreground Service](https://notifee.app/react-native/docs/android/foreground-service) | Long running background tasks can take advantage of an Android Foreground Service to display an on-going, prominent notification. |
| [Grouping & Sorting](https://notifee.app/react-native/docs/android/grouping-and-sorting) | Group and sort related notifications in a single notification pane. |
| [Interaction](https://notifee.app/react-native/docs/android/interaction) | Allow users to interact with your application directly from the notification, with actions. |
| [Progress Indicators](https://notifee.app/react-native/docs/android/progress-indicators) | Show users a progress indicator of an on-going background task, and learn how to keep it updated. |
| [Styles](https://notifee.app/react-native/docs/android/styles) | Style notifications to show richer content, such as expandable images/text, or message conversations. |
| [Timers](https://notifee.app/react-native/docs/android/timers) | Display counting timers on your notification, useful for on-going tasks such as a phone call, or event time remaining. |
| [Appearance](https://docs.page/invertase/notifee/react-native/android/appearance) | Change the appearance of a notification; icons, colors, visibility etc. |
| [Behaviour](https://docs.page/invertase/notifee/react-native/android/behaviour) | Customize how a notification behaves when it is delivered to a device; sound, vibration, lights etc. |
| [Channels & Groups](https://docs.page/invertase/notifee/react-native/android/channels) | Organize your notifications into channels & groups to allow users to control how notifications are handled on their device |
| [Foreground Service](https://docs.page/invertase/notifee/react-native/android/foreground-service) | Long running background tasks can take advantage of an Android Foreground Service to display an on-going, prominent notification. |
| [Grouping & Sorting](https://docs.page/invertase/notifee/react-native/android/grouping-and-sorting) | Group and sort related notifications in a single notification pane. |
| [Interaction](https://docs.page/invertase/notifee/react-native/android/interaction) | Allow users to interact with your application directly from the notification, with actions. |
| [Progress Indicators](https://docs.page/invertase/notifee/react-native/android/progress-indicators) | Show users a progress indicator of an on-going background task, and learn how to keep it updated. |
| [Styles](https://docs.page/invertase/notifee/react-native/android/styles) | Style notifications to show richer content, such as expandable images/text, or message conversations. |
| [Timers](https://docs.page/invertase/notifee/react-native/android/timers) | Display counting timers on your notification, useful for on-going tasks such as a phone call, or event time remaining. |

### iOS

Below you'll find guides that cover the supported iOS features.

| Topic | |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------ |
| [Appearance](https://notifee.app/react-native/docs/ios/appearance) | Change how the notification is displayed to your users. |
| [Behaviour](https://notifee.app/react-native/docs/ios/behaviour) | Control how notifications behave when they are displayed on a device; sound, crtitial alerts, etc. |
| [Categories](https://notifee.app/react-native/docs/ios/categories) | Create & assign categories to notifications. |
| [Interaction](https://notifee.app/react-native/docs/ios/interaction) | Handle user interaction with your notifications. | |
| [Permissions](https://notifee.app/react-native/docs/ios/permissions) | Request permission from your application users to display notifications. | |
| [Appearance](https://docs.page/invertase/notifee/react-native/ios/appearance) | Change how the notification is displayed to your users. |
| [Behaviour](https://docs.page/invertase/notifee/react-native/ios/behaviour) | Control how notifications behave when they are displayed on a device; sound, crtitial alerts, etc. |
| [Categories](https://docs.page/invertase/notifee/react-native/ios/categories) | Create & assign categories to notifications. |
| [Interaction](https://docs.page/invertase/notifee/react-native/ios/interaction) | Handle user interaction with your notifications. | |
| [Permissions](https://docs.page/invertase/notifee/react-native/ios/permissions) | Request permission from your application users to display notifications. | |


## License
Expand Down

0 comments on commit 5f5b301

Please sign in to comment.