Skip to content
/ README Public template

๐Ÿ“ README.md template to facilitate new projects

License

Notifications You must be signed in to change notification settings

puria/README

Folders and files

NameName
Last commit message
Last commit date

Latest commit

May 9, 2023
b8aab35 ยท May 9, 2023

History

22 Commits
Feb 10, 2019
Jun 27, 2019
May 9, 2023

Repository files navigation

{project_name}

{tagline}




{project_name} Features

{screenshot}



๐Ÿ’พ Install

pip install / yard add {project_name}

๐Ÿ” back to top


๐ŸŽฎ Quick start

To start using {project_name} run the following command in the root folder

docker compose up

๐Ÿ” back to top


๐Ÿš‘ Community & support

๐Ÿ“ Documentation - Getting started and more.

๐ŸŒฑ Ecosystem - Plugins, resources, and more.

๐Ÿšฉ Issues - Bugs end errors you encounter using {project_name}.

๐Ÿ’ฌ Discussions - Get help, ask questions, request features, and discuss {project_name}.

[] Matrix - Hanging out with the community.

๐Ÿ—ฃ๏ธ Discord - Hanging out with the community.

๐Ÿช Telegram - Hanging out with the community.

๐Ÿ“– Example - An example repository that uses {project_name}.

๐Ÿ” back to top


๐Ÿ‹ Docker

Please refer to DOCKER PACKAGES

๐Ÿ” back to top


๐Ÿ API

Available endpoints

POST /token

Execute a transaction with some amount

Parameters

Name Required Type Description
token required string Type of token. Accepted values idea or strength
amount required number Transaction's token amount
owner required ULID The ULID of the Agent's owner

GET /token/${request.token}/${request.owner}

Retrieves the actual value of the token type for the specified owner

๐Ÿ” back to top


๐Ÿ”ง Configuration

๐Ÿ” back to top


๐Ÿ“‹ Testing

๐Ÿ” back to top


๐Ÿ› Troubleshooting & debugging

๐Ÿ” back to top


๐Ÿ˜ Acknowledgements

Copyleft ๐Ÿ„ฏ 2023 by Dyne.org foundation, Amsterdam

Designed, written and maintained by Puria Nafisi Azizi.

Special thanks to Mr. W. White for his special contributions.

๐Ÿ” back to top


๐Ÿ‘ค Contributing

Please first take a look at the Dyne.org - Contributor License Agreement then

  1. ๐Ÿ”€ FORK IT
  2. Create your feature branch git checkout -b feature/branch
  3. Commit your changes git commit -am 'feat: New feature\ncloses #398'
  4. Push to the branch git push origin feature/branch
  5. Create a new Pull Request gh pr create -f
  6. ๐Ÿ™ Thank you

๐Ÿ” back to top


๐Ÿ’ผ License

{project_name} - {tagline}
Copyleft ๐Ÿ„ฏ 2023 Dyne.org foundation, Amsterdam

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

๐Ÿ” back to top

About

๐Ÿ“ README.md template to facilitate new projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published