ascii-side-of-the-moon 1.0.2

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+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).
+
+## [1.0.0] - 2024-12-19
+
+### Added
+- Initial release
+- Moon phase, size, and libration calculations
+- Unicode terminal renderer
+- Zero runtime dependencies
+- Astronomy engine integration for accurate calculations

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Alex Yankov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,35 @@
+# WHAT
+
+`ascii-side-of-the-moon` is a small library that prints an ascii representation of the moon on a given date.
+
+## Example
+
+```js
+import { getMoonState, renderMoon } from 'ascii-side-of-the-moon';
+
+// Get moon state for January 1st, 2025
+const date = new Date(2025, 0, 1); // Note: month is 0-based in JavaScript
+const moonState = getMoonState(date);
+
+// Render the moon's ASCII representation
+const moonAscii = renderMoon(moonState);
+
+// Print to console
+console.log(moonAscii);
+```
+
+## Local Demo
+Inside of repository for `ascii-side-of-the-moon`.
+
+Render a single date:
+```sh
+pnpm run render:demo 2025-01-01
+```
+
+Render an animation:
+```sh
+pnpm run render:demo_animate 2025-01-01 2025-12-30
+```
+
+## Char aspect ratio.
+This package assumes a character ratio of 10/22.