diff --git a/README.md b/README.md index d542521..2743ff6 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,25 @@ -# LOCKER +# JUPITER LOCKER -Allow user to lock token based on a vesting plan +Open source program to allow user to lock token based on a vesting plan -### Tests - -#### Program +## For developer +To run all the test, please run the following commands: ``` anchor test -- --features localnet -``` \ No newline at end of file +``` + +Build programs: +``` +anchor build +``` + + +## Audit +Jupiter Locker has been audited by Sec3 (prev.Soteria). View the audit report [here](./audits/jup-lock_report_final.pdf). + + +## License +Anchor is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Jupiter Locker by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions. \ No newline at end of file diff --git a/audits/jup-lock_report_final.pdf b/audits/jup-lock_report_final.pdf new file mode 100644 index 0000000..5f455ef Binary files /dev/null and b/audits/jup-lock_report_final.pdf differ diff --git a/programs/locker/Cargo.toml b/programs/locker/Cargo.toml index 8b4a397..b938eb3 100644 --- a/programs/locker/Cargo.toml +++ b/programs/locker/Cargo.toml @@ -3,6 +3,7 @@ name = "locker" version = "0.2.1" description = "Created with Anchor" edition = "2021" +author = "andrew@raccoons.dev" [lib] crate-type = ["cdylib", "lib"]