jmcdo29 / ogma

A monorepo for the ogma logger and related packages
https://ogma.jaymcdoniel.dev
MIT License
288 stars 36 forks source link

docs: updated readme #1818

Open Tony133 opened 6 months ago

Tony133 commented 6 months ago

Proposal:

Updated the readme documents so they are aligned with the one documented on Ogma's site: https://ogma.jaymcdoniel.dev/en/introduction/

changeset-bot[bot] commented 6 months ago

⚠️ No Changeset found

Latest commit: 1b8ab6380e77bd1152d0b4e7f5bff9c756346c29

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

nx-cloud[bot] commented 6 months ago

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 1b8ab6380e77bd1152d0b4e7f5bff9c756346c29. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 3 targets - [`nx affected --target=build --parallel=3 --exclude=docs`](https://cloud.nx.app/runs/6l06RYzO4s?utm_source=pull-request&utm_medium=comment) - [`nx affected --target=test --parallel=3`](https://cloud.nx.app/runs/VwrmwCcE9H?utm_source=pull-request&utm_medium=comment) - [`nx affected --target=lint --parallel=3`](https://cloud.nx.app/runs/bawCD3TjqM?utm_source=pull-request&utm_medium=comment)

Sent with 💌 from NxCloud.

jmcdo29 commented 3 months ago

The changes are correct, but rather than keeping documentation in two places, I'm gonna update the READMEs to point to the hosted documentation so that I don't end up needing to do more maintenance

Tony133 commented 3 months ago

The changes are correct, but rather than keeping documentation in two places, I'm gonna update the READMEs to point to the hosted documentation so that I don't end up needing to do more maintenance

Yes, I agree better to have everything in one place 😉 👍