Skip to content

Commit

Permalink
Removed outdated change description line, add comment template info s…
Browse files Browse the repository at this point in the history
…ection and instructions to avoid merge conflicts (#77)
  • Loading branch information
tjcouch-sil authored Aug 29, 2024
2 parents 8d7fc6f + 0179014 commit ccbc2d1
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Basic extension template for Platform.Bible

<!-- <!-- Opening comment tag for Template Info Section. Ignore this for now. More info in [Hide Template Info](#hide-template-info). -->

## Template Info

This is a webpack project template pre-configured to build a Platform.Bible extension. It contains the bare minimum of what an extension needs. Note that the `*.web-view.*` files and the `public/assets` folder mentioned in [Summary](#summary) are not present in this template. For inspiration on what these could look like, refer to any extension that is built using this template. An example would be the [Text Collection extension](https://github.com/paranext/paranext-extension-text-collection).
Expand Down Expand Up @@ -32,13 +34,11 @@ To make the process of customizing from the template as smooth as possible, we r
- In `manifest.json`:

- Replace `paranext-extension-template` with `your-extension-name` (2 occurrences)
- Replace the description with your own description
- Update ownership information and other relevant fields as desired

- In `package.json`:

- Replace `paranext-extension-template` with `your-extension-name` (2 occurrences)
- Replace the description with your own description
- Update ownership information and other relevant fields as desired

- In `assets/displayData.json`:
Expand Down Expand Up @@ -69,9 +69,13 @@ To make the process of customizing from the template as smooth as possible, we r

The `manifest.json` and `package.json` files contain information specific to your extension. Add your extension's details in these two files as needed. See more information on the `manifest.json` and `package.json` files in [Extension Anatomy](https://github.com/paranext/paranext-extension-template/wiki/Extension-Anatomy#extension-manifest).

#### Remove Template Info
#### Hide Template Info

Once finished customizing this template to be your own, you can uncomment the [HTML comment tag](https://www.w3schools.com/html/html_comments.asp) above the [Template Info](#template-info) section to hide this template-related info in this readme. Leaving this info commented in your readme will hide it in your readme while avoiding merge conflicts if you decide to [update this extension from the template](#to-update-this-extension-from-the-template) in the future. If you never want to update this extension from the template, you can remove the [Template Info](#template-info) section and sub-sections of this readme.

Note: if you [update this extension from the template](#to-update-this-extension-from-the-template), there may be important changes in this section like additional customizations you must make to this extension. Please keep an eye out for readme changes when updating from the template.

Once finished customizing this template to be your own, you can remove the [Template Info](#template-info) section and sub-sections of this readme.
<!-- Closing comment tag for Template Info Section -->

## Summary

Expand Down

0 comments on commit ccbc2d1

Please sign in to comment.