Skip to content
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

Updates to order of operations and accurate steps in the readme for creating a project #82

Merged
merged 3 commits into from
Feb 12, 2024

Conversation

jwafu
Copy link
Contributor

@jwafu jwafu commented Feb 7, 2024

Specific updates following usage by a contributor (sean) via Discord

Description
Goal is to make the dev experience outlined in the readme more accurate and easier to follow when first setting up an environment from scratch. Will also include some other updates as well with new endpoint examples.

Also moving forward a goal of ours is to keep this readme and the readme on the npm package in sync with each other excluding some minor header details.

  • update order of ops and steps for creating a project from seans research
  • update headers to reflect API calls instead of stoplight naming convention
  • add additional examples from other projects and docs

…reating a project

specific updates following usage by a contributor (sean) via Discord
@jwafu jwafu added documentation Improvements or additions to documentation enhancement New feature or request community review something that requires feedback from the community labels Feb 7, 2024
@jwafu jwafu self-assigned this Feb 7, 2024
README.md Outdated Show resolved Hide resolved
@seantiz
Copy link
Contributor

seantiz commented Feb 7, 2024

Just commenting to get on this

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@CBID2 CBID2 left a comment

Choose a reason for hiding this comment

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

Hi @jordan-pieces. I mostly gave feedback on grammar errors.

Copy link
Contributor Author

@jwafu jwafu left a comment

Choose a reason for hiding this comment

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

👍

@jwafu jwafu merged commit 9d8272e into main Feb 12, 2024
1 check passed
@jwafu jwafu deleted the readme-updates-feb2024 branch February 26, 2024 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community review something that requires feedback from the community documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants