Minor consistency tweaks to Readme file (#95)

* Minor consistency tweaks to Readme file

* Update package.json to match readme

* Change heading to be consistent

Author: sblaurock

README.md

@@ -1,12 +1,12 @@
-# Constructor.io Product Listing Pages (PLP) UI Library
+# Constructor.io PLP UI Library
 
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Constructor-io/constructorio-ui-plp/blob/main/LICENSE)
 
 ## Introduction
 
-A UI Library that provides React components to manage the fetching and rendering logic for [Search](https://constructor.io/products/search/) & [Browse](https://constructor.io/products/browse/) pages powered by Constructor.io. Typescript support is available.
+A UI library that provides React components to manage the fetching and rendering logic for [Search](https://constructor.io/products/search/) & [Browse](https://constructor.io/products/browse/) product listing pages powered by Constructor. Typescript support is available.
 
-Our [Storybook Docs](https://constructor-io.github.io/constructorio-ui-plp/?path=/docs/general-introduction--documentation) are the best place to explore the behavior and the available configuration options for this UI Library.
+Our [Storybook Docs](https://constructor-io.github.io/constructorio-ui-plp/?path=/docs/general-introduction--documentation) are the best place to explore the behavior and the available configuration options for this UI library.
 
 ## Installation
 
@@ -32,52 +32,53 @@ function YourComponent() {
 }
 ```
 
-### Using the Javascript Bundle
+### Using the JavaScript Bundle
 
 This is a framework agnostic method that can be used in any JavaScript project. The `CioPlp` function provides a simple interface to inject an entire PLP UI into the provided `selector`.
+
 In addition to [PLP component props](https://constructor-io.github.io/constructorio-ui-plp/?path=/docs/plp-component--docs), this function also accepts `selector` and `includeCSS`.
 
 ```js
 import CioPlp from '@constructor-io/constructorio-ui-plp/constructorio-ui-plp-bundled';
 
 CioPlp({
   selector: '#plp-container',
-  includeCSS: true, // Include the default CSS styles. Defaults to true.
+  includeCSS: true, // Include the default CSS styles - defaults to true
   apiKey: 'key_M57QS8SMPdLdLx4x',
   // ... additional arguments
 });
 ```
 
 ## Custom Styling
 
-### Library defaults
+### Library Defaults
 
-By default, importing React components from this library does not pull any css into your project.
+By default, importing React components from this library does not pull any CSS into your project.
 
-If you wish to use some starter styles from this library, add an import statement similar to the example import statement below:
+If you wish to use starter styles from this library, add an import statement similar to the example import statement below:
 
 ```js
 import '@constructor-io/constructorio-ui-plp/styles.css';
 ```
 
-- These starter styles can be used as a foundation to build on top of, or just as a reference for you to replace completely.
+- The starter styles can be used as a foundation to build on top of, or as a reference to be replaced completely.
 - To opt out of all default styling, simply do not import the `styles.css` stylesheet.
-- All starter styles in this library are scoped within the `.cio-plp` css selector.
-- These starter styles are intended to be extended by layering in your own css rules
-- If you import the starter styles, `CioPlp` component will take up the full width and height of its parent container
+- All starter styles in this library are scoped within the `.cio-plp` CSS selector.
+- The starter styles are intended to be extended by layering in your own CSS rules.
+- If the starter styles are imported, `CioPlp` component will take up the full width and height of the parent container.
 
 > Please note the starter styles utilize @container queries and enable responsive styles for our PLPs based on the size of their container element. Since this feature is supported by modern browsers, polyfills have not been included in this library. However, if you want to support older browsers, you can add fallback styles or use a [polyfill](https://github.com/GoogleChromeLabs/container-query-polyfill).
 
 ## Troubleshooting
 
 ### Known Issues
 
-**Older Javascript environments**
+**Older JavaScript environments**
 
-The library provides two different builds. CommonJS (cjs) and ECMAScript Modules (mjs) 
+The library provides two different builds: CommonJS (cjs) and ECMAScript Modules (mjs).
 
-For ECMAScript Modules (mjs) build. The Javascript version is ESNext which might not be supported by your environment.
-If that's the case and your environment is using an older Javascript version like ES6 (ES2015), you might get this error.
+For ECMAScript Modules (mjs) build. The JavaScript version is ESNext which might not be supported by your environment.
+If that's the case and your environment is using an older JavaScript version like ES6 (ES2015), you may get this error:
 
 `Module parse failed: Unexpected token (15:32)
 You may need an appropriate loader to handle this file type, currently no loaders are configured to process this file`
@@ -92,27 +93,23 @@ There is a known issue with ESLint where it fails to resolve the paths exposed i
 
 `Unable to resolve path to module '@constructor-io/constructorio-ui-plp/styles.css'`
 
-Relevant open issues:
-
-[Issue 1868](https://github.com/import-js/eslint-plugin-import/issues/1868)
-
-[Issue 1810](https://github.com/import-js/eslint-plugin-import/issues/1810)
+Relevant open issues: [Issue 1868](https://github.com/import-js/eslint-plugin-import/issues/1868), [Issue 1810](https://github.com/import-js/eslint-plugin-import/issues/1810)
 
 ## Local Development
 
-### Development scripts
+### Development Scripts
 
 ```bash
-npm ci                  # install dependencies for local dev
-npm run dev             # start a local dev server for Storybook
-npm run lint            # run linter
+npm ci                  # Install dependencies for local dev
+npm run dev             # Start a local dev server for Storybook
+npm run lint            # Run lint
 ```
 
-### Maintain Library
+### Library Maintenance
 
 ```bash
-npm run compile           # generate lib folder for publishing to npm
-npm run build-storybook   # generate storybook static bundle for deploy with GH Pages
+npm run compile           # Generate lib folder for publishing to npm
+npm run build-storybook   # Generate Storybook static bundle for deploy with GitHub Pages
 ```
 
 ## Supporting Docs

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@constructor-io/constructorio-ui-plp",
   "version": "0.0.1",
-  "description": "Constructor.io Product Listing Pages UI library for web applications",
+  "description": "Constructor.io PLP UI library for web applications",
   "author": "constructor.io",
   "license": "MIT",
   "homepage": "https://github.com/Constructor-io/constructorio-ui-plp#readme",