From 3bb7289f9dd8aa44b6f9c5d0688171bdbfb24ab1 Mon Sep 17 00:00:00 2001 From: ZigBalthazar Date: Tue, 16 Jul 2024 00:02:57 +0330 Subject: [PATCH] docs: readme --- README.md | 42 ++++++++++-------------------------------- 1 file changed, 10 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 0c6c2c2..cf2d1eb 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,19 @@ -# Website -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +# Tonion Documentation -### Installation +Welcome to the official documentation for Tonion projects. -``` -$ yarn -``` +## About -### Local Development +Tonion provides comprehensive guides and examples for developers using the Tact language on the Ton blockchain. -``` -$ yarn start -``` +## Features -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +- **Guides**: Step-by-step tutorials for setup, deployment, and integration. +- **Examples**: Real-world scenarios showcasing Tonion usage. -### Build +## Getting Started -``` -$ yarn build -``` +Explore different sections like guides, API references, and examples to find what you need. Contributions are welcome via GitHub. -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -### Deployment - -Using SSH: - -``` -$ USE_SSH=true yarn deploy -``` - -Not using SSH: - -``` -$ GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +Visit [tonion.tech](https://tonion.tech) for more details.