Skip to content

docs: readme #219

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

Open
bravesasha wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: readme #219

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
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

[![Go Report Card](https://goreportcard.com/badge/github.com/iov-one/starnamed)](https://goreportcard.com/report/github.com/iov-one/starnamed)
[![GoDoc](https://godoc.org/github.com/iov-one/starnamed?status.svg)](https://pkg.go.dev/github.com/iov-one/starnamed)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)]()
![Discord](https://img.shields.io/discord/906536286653923408?label=discord&logo=discord)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/iov-one/starnamed/blob/main/LICENSE)
[![Discord](https://img.shields.io/discord/906536286653923408?label=discord&logo=discord)](https://discord.com/invite/interchain)
## The project

Starname is a blockchain platform that allows users to register and manage their own decentralized domain names, which can be used for various purposes such as sending and receiving cryptocurrency, creating unique identifiers for digital assets, and more. Starname is also a decentralized identity platform that enables users to have a universal username for the blockchain world.
Expand Down Expand Up @@ -39,7 +38,7 @@ Once you have installed the starnamed CLI, you can use it to manage your Starnam
- `starnamed keys add <your_key_name>` *This command will generate a key pair and store it in your local keyring. You will need to use this key pair to sign transactions that you send to the Starname blockchain.* **Copy the mnemonic phrase and keep it safe. You will need it to recover your key pair if you lose it.**

- Adding tokens to your account:
- you can swap at the Osmosis swap pool (https://app.osmosis.zone/swap) and transfer the tokens to your account using the IBC protocol. The osmosis app has all the necessary information to do that.
- you can swap at the Osmosis swap pool (https://app.osmosis.zone/) and transfer the tokens to your account using the IBC protocol. The osmosis app has all the necessary information to do that.

- Using the starname module:
- `starnamed tx starname --help` *This command will show you all the available commands that you can use to manage your Starname account.*
Expand Down Expand Up @@ -91,4 +90,4 @@ Thanks to the current and former employees of IOV SAS and all the open-source de
* KamiD [KamiD](https://github.com/KamiD)
* Valery Litvin [litvintech](https://github.com/litvintech)
* Leonardo Bragagnolo [bragaz](https://github.com/bragaz)
* Davi Mello [dsmello](https://github.com/dsmello)
* Davi Mello [dsmello](https://github.com/dsmello)