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

fix(docs): add import note #869

Merged
merged 3 commits into from
Aug 23, 2022
Merged

fix(docs): add import note #869

merged 3 commits into from
Aug 23, 2022

Conversation

ixje
Copy link
Member

@ixje ixje commented Aug 23, 2022

closes #850 as per #850 (comment)
supersedes #868

Copy link
Member

@snowypowers snowypowers left a comment

Choose a reason for hiding this comment

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

I think we can be more direct with the recommendation. Let's lead with the TLDR and an active voice.

I suggest:

For most use-cases, we recommend `neon-js`.
Do not use `neon-js` and `neon-core`  in the same project.  The classes are not cross-package compatible. See https://github.com/CityOfZion/neon-js/issues/850.

@ixje ixje merged commit e8b471c into CityOfZion:dev Aug 23, 2022
@ixje ixje deleted the usage-docs branch August 23, 2022 07:39
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