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.

Sign up for GitHub

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c174f1
Update installation.md
ixje Aug 23, 2022
cb0f682
add import usage note
ixje Aug 23, 2022
cf8acc7
Update README.md
ixje Aug 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ console.log(Neon);
var acct = Neon.create.account("NKuyBkoGdZZSLyPbJEetheRhMjeznFZszf");
```


> **Note**
> 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.


# Contributing

Please refer to [`CONTRIBUTING`](./CONTRIBUTING.md) for development practices.
Expand Down
4 changes: 4 additions & 0 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ npm install @cityofzion/neon-core

This will give you the release that is compatible for the neo3 mainnet and testnet.

> **Note**
> 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.

## Node

Support policy is to support the maintainence and LTS versions of Node. At the
Expand Down