From 2e78dc7b42ba8e95da300df12627e7b7a748e9f4 Mon Sep 17 00:00:00 2001
From: rolfheij-sil <rolf_heij@sil.org>
Date: Wed, 6 Sep 2023 10:59:32 -0400
Subject: [PATCH] Update readme

---
 README.md | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1276178..e2b390b 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,9 @@ Basic extension template for Paranext
 
 ## Summary
 
-This is a webpack project template pre-configured to build Paranext extensions.
+This is a webpack project template pre-configured to build Paranext extensions. It contains the bare minimum of what an extension needs. Note that the `*.web-view.*` files and the `public/assets` folder mentioned below 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).
 
-- `package.json` contains information about this extension npm package. It is required for Paranext to use the extension properly. It is copied into the build folder
+- `package.json` contains information about this extension's npm package. It is required for Paranext to use the extension properly. It is copied into the build folder
 - `src` contains the source code for the extension
   - `src/main.ts` is the main entry file for the extension
   - `src/types/paranext-extension-template.d.ts` is this extension's types file that defines how other extensions can use this extension through the `papi`. It is copied into the build folder
@@ -32,6 +32,30 @@ In order to interact with `paranext-core`, you must point `package.json` to your
 
 Run `npm install` to install local and published dependencies
 
+### Configure extension details
+
+This section is a more compact version of the [`Your first extension` guide](https://github.com/paranext/paranext-extension-template/wiki/Your-First-Extension).
+
+#### Search and replace placeholders
+
+- **Search for:** paranext-extension-template
+  **Replace with:** your-extension-name
+- **Search for:** Extension Template
+  **Replace with:** Your Extension
+  (Be sure to match case)
+
+#### Filenames
+
+You need to change the filename of the `.d.ts` file, which is located in `/src/types` and referenced in the `package.json` “types” field. See more information on the [.d.ts files](https://github.com/paranext/paranext-extension-template/wiki/Extension-Anatomy#type-declaration-files-dts).
+
+#### Manifest
+
+The `manifest.json` and `package.json` files makeup your extension manifest. Add your details in these two files based on your extension name and what you renamed the files described in 1 and 2. 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).
+
+#### Webpack
+
+You will need to add your extension's name into `webpack.config.main.ts` and `webpack.util.ts`. The search and replace actions listed above will correct this for you.
+
 ## To run
 
 ### Running Paranext with your extension