Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dcalhoun committed Nov 18, 2024
1 parent cef11a2 commit d88c9f9
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

<img width="320" alt="Screenshot 2024-07-01 at 10 30 11 AM" src="https://github.com/kean/GutenbergKit/assets/1567433/4d9b2fcd-30fa-46ca-895d-07e0848143b1">

## 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:

Expand All @@ -20,15 +20,15 @@ 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

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.

<img width="725" alt="Screenshot 2024-07-01 at 10 46 19 PM" src="https://github.com/kean/GutenbergKit/assets/1567433/cdc8a28a-c621-4b8e-bc7a-31361694434c">
<img width="725" alt="Xcode environment variables" src="https://github.com/kean/GutenbergKit/assets/1567433/cdc8a28a-c621-4b8e-bc7a-31361694434c">

If you are using SwiftUI previews, make sure to point them to the localhost programatically:

Expand All @@ -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.

0 comments on commit d88c9f9

Please sign in to comment.