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

Update README with KadenaJS Reasoning and Package List/Descriptions #168

Merged
merged 1 commit into from
Feb 17, 2023

Conversation

Luzzotica
Copy link
Contributor

Reason:

It was ludicrously hard to find a source of information that listed off all of the libraries (And planned libraries) in KadenaJS along with a description of what each one did.

I finally stumbled on the Contributions markdown file.

I just copied the data from there into the readme. The Readme definitely deserves to have that information. I'm not sure if makes sense in the contributions file.

Changes made (preferably with images/screenshots):

Add kadena js package list and descriptions to the main README so people can easily see what each piece does and find what they need faster.

Check off the following:

  • I have reviewed my changes and run the appropriate tests.
  • I have have run rush change to add the appropriate change logs.
  • I have added/edited docs.
  • I have added tutorials.
  • I have double checked and DEFINITELY added docs.

@Randynamic
Copy link
Contributor

#42 <-- list

Copy link
Member

@alber70g alber70g left a comment

Choose a reason for hiding this comment

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

I’m OOO this week but I really like what you did here. Before we merge this we need to define what we want to add in the readme.

I would like something similar to this table under “Published Packages” https://github.com/microsoft/rushstack/blob/main/README.md

Let me know your thoughts

@Luzzotica
Copy link
Contributor Author

I’m OOO this week but I really like what you did here. Before we merge this we need to define what we want to add in the readme.

I would like something similar to this table under “Published Packages” https://github.com/microsoft/rushstack/blob/main/README.md

Let me know your thoughts

I believe adding all of the links would be very beneficial, and be a great improvement to the changes I made, yes.
I'm all for it.
Would you like me to do it?

I believe that either way though, these changes are already an improvement to the repo itself, and should be merged.
Incremental changes. If everyone feels this is already an improvement, let's merge it.
Then we can "define what we want to add in the readme". Glad this PR got the conversation started.

@Luzzotica Luzzotica mentioned this pull request Feb 13, 2023
Copy link
Contributor

@Randynamic Randynamic left a comment

Choose a reason for hiding this comment

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

Agreed I'll merge this. It would be great if you want to help us out on that part. Let's keep the discussion going.

@Randynamic Randynamic merged commit 5cba43d into kadena-community:master Feb 17, 2023
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.

None yet

4 participants