diff --git a/README.md b/README.md index cd6d8d3..c6a5ba3 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # GutenbergKit -A proof of concept Gutenberg editor for native iOS apps built using web technologies. +A proof of concept Gutenberg editor for native iOS and Android apps built using web technologies. Screenshot 2024-07-01 at 10 30 11 AM ## Development -Before getting started, you'll need the Node dependencies to be checked out locally, which you can get by running `make build`. +Before starting, you'll need the Node.js dependencies to be installed locally, which you can install by running `make build`. ### React App -The ReactJS app is embedded in the native GutenbergKit module. +The React app is embedded in the native GutenbergKit module. To launch the app in the browser, run: @@ -20,7 +20,7 @@ make dev-server ### GutenbergKit -A Swift package with native wrappers for the Gutenberg editor. +Swift and Kotlin packages with native wrappers for the Gutenberg editor. ### Demo @@ -28,7 +28,7 @@ A host app that can be used to test the changes made to the editor quickly. By default, the demo app uses a production build of the React app included in the `GutenbergKit` package. During development, make sure to run the React app and pass the localhost URL as an environment variable of the demo app. -Screenshot 2024-07-01 at 10 46 19 PM +Xcode environment variables If you are using SwiftUI previews, make sure to point them to the localhost programatically: @@ -43,10 +43,10 @@ If you are using SwiftUI previews, make sure to point them to the localhost prog ## Production -To build the React app for production and incorporate the changes in the `GutenbergKit` Swift module, run: +To build the React app for production and incorporate the changes in the `GutenbergKit` Swift and Kotlin packages, run: ``` make build ``` -Once it's done, the Swift package is ready to be published. +Once it's done, the Swift and Kotlin packages are ready to publish.