coh-content-db 2.0.0-rc.5 → 2.0.0-rc.7

package/README.md

@@ -25,7 +25,7 @@ that can be loaded into the db for consumption by DB consumers such as [Badger](
 
 For an example data package, see the [coh-content-db-homecoming](https://github.com/n15g/coh-content-db-homecoming) project.
 
-### Defining archetypes, map, badges, etc.
+### Defining archetypes, zones, badges, etc.
 
 To define content, create a new instance using the appropriate `Data` interface and provide values for the required fields:
 
@@ -35,19 +35,19 @@ import { BadgeData } from 'coh-content-db'
 
 export const TEST_BADGE: BadgeData = {
     key: 'test-badge',
-    type: 'ACHIEVEMENT',
-    name: [{ value: 'Test Badge' }, { alignment: 'P', value: 'My Badge for Praetorians' }],
-    alignment: ['H', 'V', 'P'],
+    type: 'achievement',
+    name: [{ value: 'Test Badge' }, { alignment: 'praetorian', value: 'My Badge for Praetorians' }],
+    alignment: ['hero', 'praetorian'],
 }
 ```
 
-Then, create a `ServerGroupData` instance and load your content into the appropriate field.
+Then, create a `ContentBundle` instance and load your content into the appropriate field.
 
 ```typescript
 import { ContentBundle } from './content-bundle'
 import { TEST_BADGE } from './test-badge'
 
-export const TEST_SERVER_GROUP: ContentBundle = {
+export const MY_CONTENT_BUNDLE: ContentBundle = {
     name: 'My Content Bundle',
     badges: [TEST_BADGE],
 }
@@ -57,7 +57,7 @@ export const TEST_SERVER_GROUP: ContentBundle = {
 
 Fields with long text values can typically accept [Markdown](https://www.markdownguide.org/) format. These fields will also be typed with the tag type [MarkdownString](src/main/api/markdown-string.ts).
 
-Within markdown, you can construct a link to a badge or map using the special `badge://` and `map://` protocol indicators that consumer apps can use to provide runtime links or tooltips.
+Within markdown, you can construct a link to a badge or zone using the special `badge://` and `zone://` protocol indicators that consumer apps can use to provide runtime links or tooltips.
 This replaces the custom `[badge:xyz]` format from v1 and data packages will need to update accordingly.
 
 To create a link, use the standard Markdown link format, with the url as following: