Skip to content

Commit

Permalink
chore: update README (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
ya7on authored Jan 7, 2025
1 parent b6144be commit 1279f2c
Showing 1 changed file with 35 additions and 4 deletions.
39 changes: 35 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,29 @@
[![Build status](https://img.shields.io/github/actions/workflow/status/supadupadao/minter/build.yml?label=build)](https://github.com/supadupadao/minter/actions/workflows/build.yml)
[![GitHub License](https://img.shields.io/github/license/supadupadao/minter)](https://github.com/supadupadao/minter/blob/master/LICENSE)

ℹ️ Web application for deploying and management TON Jettons. This application is based on our [Jetton](https://github.com/supadupadao/jetton) implementation

⚠️ <b>Warning!</b> Application is actively work in progress. It could work not well
ℹ️ Web application for deploying and management TON Jettons.

❤️ Any contributions are welcome. Feel free to open pull requests, issues, bug reports, feature proposals or anything else

🌍 Last version of application automatically deploys at [minter.supadupa.space](https://minter.supadupa.space)
🌍 Last version of application automatically deploys at [minter.supadupa.space](https://minter.supadupa.space) by pushing to `master` branch

# Features

🆕 **Jetton deploy**:

Using this application you can deploy new TON Jetton. This application is based on our Jetton standard implementation written in [Tact language](https://tact-lang.org). This implementation build with goal to store full metadata on-chain and be usable with DAO. [More about this jetton implementation you can read in it's repo](https://github.com/supadupadao/jetton)

🎚️ **Jetton management**:

This application provides functionality to manage your deployed jettons. [You can see example of this feature here](https://minter.supadupa.space/manage/kQC1I2HcAkUSfMCQCezbL9bVtC_kqnX-gQIToAqXJNTP7yVj)

# Translation

If you find wrong translation, typo etc, please open Pull Request with fixes. You can find translation files in `src/i18n/` directory.

Supported languages:
- English - `src/i18n/en.json`
- Russian - `src/i18n/ru.json`

# Development

Expand All @@ -20,3 +36,18 @@ This is default Tact blueprint project with default commands:
- `npm run dev` - run development web server with hot reaload compilation
- `npm run build` - check types and compile for production
- `npm run lint` - run [ESLint](https://eslint.org)

## Project structure

- `public/` - directory with public files with access from root directory in deployed website
- `src/` - all source codes of application
- `assets/` - static assets directory
- `components/` - Vue components directory
- `i18n/` - translations files
- `router/` - vue-router configuration files
- `utils/` - non-Vue utils
- `views/` - big Vue components on which vue-router refers to

# License

[GNU Affero General Public License v3.0](https://github.com/supadupadao/minter/blob/master/LICENSE)

0 comments on commit 1279f2c

Please sign in to comment.