Skip to content

Commit 09bae35

Browse files
authored
Merge pull request #3 from line/readme-patch-1
Improve README
2 parents 9d3baef + b1de41b commit 09bae35

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# ABC Virtual Background Maker
44

5-
A standalone frontend app to generate and download zoom background image with text.
5+
A lightweight frontend app to generate and download virtual background image with text.
66

77
![screenshot-of-abc-virtual-background-maker](./docs/screenshot.png)
88

@@ -22,7 +22,7 @@ And let's say your company is all about that unified look and drops official bac
2222
4. Image Storage Option - Manage your background images on GitHub repo, or load them from local directory.
2323
5. Mirror Image Option - Download a reversed version of the image to accommodate video feeds that flip your background horizontally.
2424
6. Image Upload Capability - Beyond using the preloaded backgrounds, users can also upload their own picture to create personalized virtual backgrounds.
25-
7. Custom Brand Colors - Select a key color to align UI with your organization's other sites.
25+
7. Customizable Appearance - Change the UI with your organization's key color and name for a consistent look across your sites.
2626
8. No Fuss App - It's a straightforward React web app that doesn't mess around with backend stuff.
2727

2828
## Getting Started
@@ -52,7 +52,7 @@ And let's say your company is all about that unified look and drops official bac
5252
http://localhost:5173/
5353
```
5454

55-
### 🐙 Github Pages Deployment
55+
### 🐙 GitHub Pages Deployment
5656

5757
You can deploy directly from your GitHub repository using [GitHub Pages](https://pages.github.com/) at `Setting > Pages > Github Actions` menu.
5858
Check our deployment workflow with [GitHub Actions](https://docs.github.com/en/actions) at [.github/workflows/deploy.yml](https://github.com/line/abc-virtual-background-maker/blob/main/.github/workflows/deploy.yml)
@@ -96,10 +96,10 @@ You can choose where to load background images from. Currently, we are supportin
9696

9797
- with GitHub repository
9898

99-
You can manage background images using a GitHub repository. Create a GitHub repository and suppose that you have a repository with the following structure:
99+
You can manage background images using a GitHub repository. Suppose that you created a repository with the following structure:
100100

101101
```
102-
your-repo-name
102+
your-background-repo
103103
├── backgrounds
104104
│ ├── (app.config.json) // Optional. Without this configuration file, themes and background images are sorted alphabetically.
105105
│ ├── your-theme-name
@@ -257,9 +257,7 @@ To change the color of the UI elements such as toggles and buttons, you can add
257257

258258
You may want to override default values for specific theme. We support this feature by placing **another** `app.config.json` file under `backgrounds` directory.
259259

260-
In `app.config.json` structure, `themes` node can be overridden by `app.config.json` file in `backgroundsUri` path. It means, you maintain **root** `app.config.json` for common values, and you can override values for specific theme by placing **another** `app.config.json` under `backgrounds/{theme-name}` directory.
261-
262-
Let say you have `app.config.json` file in `backgrounds` directory, and you want to override `themes` node for `office` theme, you can place `app.config.json` file in `backgrounds/office` directory as below;
260+
In `app.config.json` structure, `themes` node can be overridden by `app.config.json` file in `backgroundsUri` path. It means, you maintain **root** `app.config.json` for common values, and you can override values for specific theme by placing **another** `app.config.json` under `backgrounds` directory as below;
263261

264262
```
265263
your-background-directory
@@ -270,7 +268,7 @@ your-background-directory
270268
│ │ ├── 02.jpg
271269
```
272270

273-
With above structure, if you want to override `defaultInputFields` for specific theme, you can add `inputFields` value in `app.config.json` under each `theme` node as below.
271+
With above structure, let say you want to override `themes` node for `office` theme. If you want to override `defaultInputFields` for specific theme, you can add `inputFields` value in `app.config.json` under each `theme` node as below.
274272

275273
```json
276274
{

0 commit comments

Comments
 (0)