Skip to content

add back README.md #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add back README.md #35

wants to merge 1 commit into from

Conversation

NathanRLiu
Copy link

@NathanRLiu NathanRLiu commented May 16, 2023

Pull Request Type

  • Feature
  • Bug Fix

Link to Notion Task or Github Issue

Summary of Feature(s)

add readme

Summary of Bug Fix(es)

Previous Behaviour

Description of the bug and it's impact
Previously, the README.md was blank

New Behaviour

Description of the bug fix and it's impact
I brought back the README which was taken out in [7de8d03]

Other details

Dependencies

N/A

Copy link
Contributor

@zsimjee zsimjee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! This readme was old, but we can def suggest a new one. Maybe something like

# opsconsole
This package is part of the larger opsconsole project. See https://github.com/tinystacks/opsconsole for more details and how to get started.

# ops-core
This package is shared between ops-api and ops-frontend. Opsconsole works by starting a frontend and api that both share widget resources. This package manages some of those resources. Its primary goals are to 

1. Parse through console yaml files
2. Find and install dependencies
3. Provide a way for the frontend and api to dynamically resolve those dependencies.

@zsimjee
Copy link
Contributor

zsimjee commented May 16, 2023

Please update the RELEASENOTES.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants