Added early roadmap (#10)

* Added early roadmap

* patches and update to README

* revert patch
This commit is contained in:
2026-04-23 00:52:03 +05:30
committed by GitHub
parent 396c743d93
commit a85eb65134

View File

@@ -2,14 +2,14 @@
A small React Native document scanner. Point it at a page, it crops the edges, lets you review, and saves a PDF you can share. A small React Native document scanner. Point it at a page, it crops the edges, lets you review, and saves a PDF you can share.
Built on top of [`react-native-document-scanner-plugin`](https://github.com/websitebeaver/react-native-document-scanner-plugin), with `react-native-html-to-pdf` for export and `react-native-share` for sending things out. Built on [`react-native-document-scanner-plugin`](https://github.com/websitebeaver/react-native-document-scanner-plugin) with a custom native PDF generator and `react-native-share` for export.
## What's in it ## What's in it
- Scan multi-page documents with automatic edge detection - Scan multi-page documents with automatic edge detection (Google ML Kit on Android, VisionKit on iOS)
- Review pages before saving (reorder, retake, apply a filter) - Review pages and apply filters (Original, Grayscale, B&W, Enhanced)
- Persist scans locally, rename them, view them later - Persist scans locally, rename and delete them
- Export as PDF and share - Export as PDF share a single page or the whole document
Screens live in `src/screens/``Home`, `Scan`, `Review`, `Viewer`. Navigation is plain state in `App.tsx`; there's no router dependency. Document storage is a simple hook (`src/hooks/useDocumentStore.ts`). Screens live in `src/screens/``Home`, `Scan`, `Review`, `Viewer`. Navigation is plain state in `App.tsx`; there's no router dependency. Document storage is a simple hook (`src/hooks/useDocumentStore.ts`).
@@ -78,5 +78,12 @@ patches/ # patch-package patches applied postinstall
## Notes ## Notes
- `Alert.prompt` is iOS-only; the rename flow falls back to a modal on Android (see `App.tsx`). - PDF generation is handled by a custom native module (`PdfGeneratorModule.kt` / `PdfGeneratorModule.swift`) rather than a third-party library.
- `postinstall` runs `patch-package` — if a patch fails to apply after a dependency bump, check `patches/`. - `postinstall` runs `patch-package` — if a patch fails to apply after a dependency bump, check `patches/`.
## Roadmap
- [ ] 1. Getting the App to a stable working state with no unpredictable behaviour.
- [ ] 2. Create a simple logo for the App.
- [ ] 4. Adding a sponsor/donate, share and contact us button.
- [ ] 3. Post the app on Play Store.