v1.0.0 - PR #3 from glenn2223

First official release

Author: glenn2223

CHANGELOG.md

@@ -26,28 +26,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-> **⚠ Alphas may contain breaking changes between releases.**
->
-> When the release is NOT a major release, the breaking changes will only be relative to the prior `alpha` release
->
-> As this package is not released (kind of), this change log will be cleared on the official release of `v1`
-
-## v0.0.0-alpha.1
-
-### Changes
-
--   Updated the `gitnore`, `tsconfig` and `npm` package to appropriately handle the new `lib/` folder
--   Added dependencies for, and tweaked, linting
--   Added `.prettierrc` for consistent formatting (and applied it)
--   Added some package scripts for linting, formatting, building, etc
--   Added comment to a public static method
--   Removed `.npmignore` in favour of `"files"` in the `package.json`
-
-<!--
-## [1.0.0] - 2021-06-##
+## [1.0.0] - 2022-05-12
 
 **This was the first release**
 
-[unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...development
-[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/release/tag/v1.0.0
- -->
+[unreleased]: https://github.com/TopMarksDevelopment/JavaScript.HoverPosition/compare/v1.0.0...development
+[1.0.0]: https://github.com/TopMarksDevelopment/JavaScript.HoverPosition/release/tag/v1.0.0

README.md

@@ -2,6 +2,10 @@
 
 A small package to help position a floating element. This can be positioned relative to another element or to a mouse event.
 
+### Links
+- [Change log](./CHANGELOG.md)
+- [License (MIT)](./LICENSE)
+
 ## Usage
 
 If you want to position an element to another fixed element then you can use the sample below
@@ -22,11 +26,11 @@ If you'd rather position the element to the mouse's movement then you can use th
 > ⚠ It is recommended to debounce the below sample, just to prevent performance issues
 
 ```TS
-document.addEventListener("mousemove", function(e){
+document.addEventListener("mousemove", function(mouse){
     const target = document.getElementById("Target"),
-        position = new HoverPosition(
+        pos = new HoverPosition(
             {
-                anchor: document.getElementById("Anchor"),
+                anchor: mouse,
                 target: target,
                 my: "top center",
                 at: "bottom center",
@@ -114,12 +118,4 @@ So, as well as those above, it will also allow:
 -   "bottom"
 -   "center"
 -   "left"
--   "right"
-
-## Changes
-
-You can see all the changes in our [change log](./CHANGELOG.md)
-
-## License
-
-This extension is licensed under the [MIT License](./LICENSE)
+-   "right"