Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
leejin-rho authored Oct 27, 2024
1 parent f2c5c3f commit b5c72bc
Showing 1 changed file with 3 additions and 11 deletions.
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,16 +72,8 @@ See **Swaggy-Swagger** [README.md](https://github.com/Swaggy-Swagger) for more d
```

5. **Make Changes to the UI**: Modify the UI as needed to fit your requirements.
6. **Build the Project**: After making changes, build the project to generate the updated version of Swaggy-Swagger UI.

```bash
npm run build
```

This command will create or update the `dist` folder with the built files.

7. **Push the Changes**: Push your changes to your forked repository. Make sure to **follow our style guide** for commit messages. The build files in the `dist` folder will be automatically pushed to the Swagger-custom Java library repository through GitHub Actions.
6. **Push the Changes**: Push your changes to your forked repository. Make sure to **follow our style guide** for commit messages. The build files in the `src` folder will be automatically pushed to the Swagger-custom Java library repository through GitHub Actions.

```bash
git add .
Expand All @@ -92,8 +84,8 @@ See **Swaggy-Swagger** [README.md](https://github.com/Swaggy-Swagger) for more d

> Note: Follow our commit message [STYLE GUIDE](https://github.com/Swaggy-Swagger/.github/blob/main/profile/STYLE_GUIDE.md) for the format of the commit messages. This is simply a recommendation, so feel free to contribute in the way you find best!
>
8. **Automated Deployment**: Once changes are pushed, GitHub Actions will automatically handle the deployment by pushing the updated `dist` folder to the relevant Java library repository.
9. **Contributing**: If you'd like to contribute your changes back to the Swaggy-Swagger UI repository, feel free to submit a pull request.
7. **Automated Deployment**: Once changes are pushed, GitHub Actions will automatically handle the deployment by pushing the updated `src` folder to the relevant Java library repository.
8. **Contributing**: If you'd like to contribute your changes back to the Swaggy-Swagger UI repository, feel free to submit a pull request.
## Contributors
Expand Down

0 comments on commit b5c72bc

Please sign in to comment.