Rename to remove Typed from names for RC.3

Author: JacobFischer

CHANGELOG.md

@@ -6,21 +6,24 @@ and this project adheres to [Semantic Versioning].
 
 ## [3.0.0] - 2021-??-??
 ### Added
-- `PublicTypedEvent`: Same as <= v2 `Event`.
+- `PublicEvent`: Same as <= v2 `Event`.
   - This can be used as a drop in replacement for the previous `Event` class
     when upgrading with no additional work.
-- `TypedEvent` also added, but lacks an `emit` member function.
-  - This is intended to be the "main" event class going forward.
 - `createEventEmitter()` is the new "main" method going forward to handle most
   events. See docs for use.
   - See [#14].
 - `createPublicEventEmitter()` also added a matching API, but with
-  `PublicTypedEvent` events instead.
+  `PublicEvent` events instead.
 
 ### Changes
 - `events` fully removed.
   - See [#8] for discussion and alternatives when upgrading.
-- `Event` replaced with `PublicTypedEvent` and `TypedEvent` listed above.
+- `Event` replaced with `PublicEvent` and `Event` listed above.
+  - This is intended to be the "main" event class going forward, but never
+    created directly.
+  - `emit` removed, use `PublicEvent` as a drop-in replacement.
+  - Constructing via `new` is no longer supported, and marked as such in the TS
+    definitions.
 - Exports changed to the new functions/classes/types.
 
 ### Fixed
@@ -43,7 +46,7 @@ and this project adheres to [Semantic Versioning].
 
 ## [1.1.1] - 2018-01-05
 ### Changes
-- Update package dependencies to resolve marked v0.3.6 security vunerability
+- Update package dependencies to resolve marked v0.3.6 security vulnerability
 - Correct the names of some tests with poor grammar/spelling
 
 ## [1.1.0] - 2017-12-31

README.md

@@ -3,8 +3,9 @@
 Strongly typed event emitters for [TypeScript](https://www.typescriptlang.org/).
 
 This is a TypeScript project, although the compiled source is available in the
-npm package, it is solely designed around the purpose of making events easier to
-work with _in TypeScript_.
+npm package without any runtime dependencies, it is solely designed around the
+purpose of making events easier to work with _in TypeScript_ via the included
+definitions.
 
 ## Purpose
 
@@ -26,28 +27,28 @@ build blocks in this library so you can use it best works in your project.
 import { createEventEmitter } from "ts-typed-events";
 ```
 
-### Simple Usage
+### Simple usage
 
 ```ts
-const { event, emit } = createEventEmitter<string>();
+const { event, emit } = createEventEmitter();
 
-event.on((str) => {
-    console.log("hey we got the string:", str);
+signal.on(() => {
+    console.log("The event triggered!");
 });
 
-emit("some string"); // prints `hey we got the string: some string`
+emit(); // prints: `The event triggered!`
 ```
 
-### Events without types (signals)
+### Strongly typed events
 
 ```ts
-const { event: signal, emit } = createEventEmitter<string>();
+const { event, emit } = createEventEmitter<string>();
 
-signal.on(() => {
-    console.log("The event triggered!");
+event.on((str) => {
+    console.log("hey we got the string:", str);
 });
 
-emit(); // prints: `The event triggered!`
+emit("some string"); // prints `hey we got the string: some string`
 ```
 
 ### async/await usage