diff --git a/README.md b/README.md index 409cb4c..9147d6d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,42 @@ -# Sui Cookbook +

+ Sui Cookbook logo +

+

Sui Cookbook

+ +The Sui Cookbook is a comprehensive resource that offers concise, practical guidance on Sui concepts and tool usage. +Its purpose is to help developers quickly get started building on Sui while still maintaining a broad, high-level +perspective. + +Within the Sui Cookbook, every subject is treated as a distinct topic, with logical relationships and hierarchies that +branch into related subtopics. + +The topics covered include: + +- Accounts +- Transactions +- Extended Technologies + - Deepbook + - zkLogin +- Miscellaneous + - BCS + +## Contribution + +All contributions to Sui Cookbook are welcome. The process is as simple as: fork, modify, pull and PR. + +## License + + Copyright 2022 McXross + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/artwork/sui-cookbook.svg b/artwork/sui-cookbook.svg new file mode 100644 index 0000000..299d7f9 --- /dev/null +++ b/artwork/sui-cookbook.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + +