Skip to content

docs: update licence, package, readme #1157

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

Merged
merged 1 commit into from
Jun 19, 2024
Merged

docs: update licence, package, readme #1157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 Sean James Han
Copyright (c) StarkWare Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
12 changes: 4 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,7 @@
</a>
</p>

## 🕹️ Usage

Install starknet with `npm`
## Installation

```bash
# latest official release (main branch)
Expand All @@ -51,13 +49,11 @@ $ npm install starknet@beta

Import `starknet` and use the [API](https://www.starknetjs.com/docs/API/).

## 🌐 API

[Click Here](https://www.starknetjs.com/docs/API/)
## 🌐 Documentation

Please refer to the following code examples [here](https://github.com/PhilippeR26/starknet.js-workshop-typescript)! :video_game:
How to [Guides](https://www.starknetjs.com/docs/guides/intro) :book: & [API](https://www.starknetjs.com/docs/API/) 💻

Guides can be found [here](https://www.starknetjs.com/docs/guides/intro) :book:
Play with [Code Examples](https://github.com/PhilippeR26/starknet.js-workshop-typescript) :video_game:

## ✏️ Contributing

Expand Down
1 change: 0 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@
"rollup"
],
"repository": "github:starknet-io/starknet.js",
"author": "Sean Han",
"license": "MIT",
"devDependencies": {
"@babel/plugin-transform-modules-commonjs": "^7.18.2",
Expand Down