Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.43 KB

README.md

File metadata and controls

41 lines (26 loc) · 1.43 KB

Whetstone 📚📝

Whetstone is a mobile app designed to track your reading progress and take notes on your reading material, making it easier to remember key insights and stay engaged with the content. It's the perfect companion for avid readers, students, and lifelong learners.

Features ✨

  • Log your reading progress
  • Take notes, add highlights, and create bookmarks
  • Organize your reading materials in a user-friendly interface
  • Sync your reading progress and notes across devices

Technologies 💻

Whetstone is built using the following technologies:

  • TypeScript
  • Expo
  • React Native
  • Firebase

Availability 📱

Whetstone is currently available for iOS. You can download it from the App Store.

Getting Started 🚀

To run Whetstone locally for development:

  1. Clone this repository: git clone https://github.com/your_username/whetstone.git
  2. Change to the project directory: cd whetstone
  3. Install dependencies: yarn install
  4. Start the Expo development server: yarn start
  5. Open the Expo app on your iOS device and scan the QR code to launch Whetstone.

Contributing 🤝

Contributions to Whetstone are welcome! If you have ideas for new features, bug fixes, or other improvements, please feel free to submit a pull request or create an issue. Your input and collaboration are highly appreciated.

License ⚖️

Whetstone is available under the MIT License. For more details, see the LICENSE file.