From bb81bf8c7b579b6c73ca60ace3e2f5fbe472eb78 Mon Sep 17 00:00:00 2001 From: Max Lynch Date: Wed, 13 Jan 2021 19:06:02 -0600 Subject: [PATCH] Update README.md --- README.md | 27 +++------------------------ 1 file changed, 3 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index f44403f..29d1bcf 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ -# Next.js + Tailwind CSS + Capacitor for mobile app development +# Next.js + Tailwind CSS + Ionic Framework + Capacitor Mobile Starter *Note: this repo is in active development and not quite ready for production use!* -This repo is a starting point for building an iOS, Android, and Progressive Web App with Tailwind CSS, Next.js, and Capacitor. It comes with some pre-built components that can be customized using Tailwind classes, and provides the most important UI controls needed to build native mobile experiences (tabs, nav bars, modals, menus, etc). +This repo is a starting point for building an iOS, Android, and Progressive Web App with Next.js, Tailwind CSS, Ionic Framework, and Capacitor. -These components are baked into the starter and will be adopted into your project. This way you gain full control over the experience and can easily modify the look and feel of the components to match your design. - -If you're looking for more of a batteries-included approach where you _don't_ adopt and maintain the components yourself, I recommend [Ionic React](https://ionicframework.com/react). - -![Screenshot](./ss.png) +Next.js handles the production React app experience, Tailwind can be used to style each page of your app, Ionic Framework provides the cross-platform system controls (navigation/transitions/tabs/etc.), and then Capacitor bundles all of it up and runs it on iOS, Android, and Web with full native access. ## What is Capacitor? @@ -17,20 +13,3 @@ You can think of [Capacitor](https://capacitorjs.com/) as a sort of "electron fo Capacitor provides access to Native APIs and a plugin system for building any native functionality your app needs. Capacitor apps can also run in the browser as a Progressive Web App with the same code. - -## Progress - -There are currently snippets for the following common mobile components: - -- [x] App Shell -- [x] Content -- [x] Tabs -- [ ] Nav (in progress) -- [ ] Next.js router integration -- [x] Icon -- [x] Menu -- [x] Modal -- [ ] Dialog -- [x] Button -- [x] Card -- [x] Safe Area