puria / README

:memo: README.md template to facilitate new projects

{project_name}

{tagline}

---

{project_name} Features

{screenshot}

LIVE DEMO

🚩 Table of Contents

• 💾 Install
• 🎮 Quick start
• 🚑 Community & support
• 🐋 Docker
• 🐝 API
• 🔧 Configuration
• 📋 Testing
• 🐛 Troubleshooting & debugging
• 😍 Acknowledgements
• 👤 Contributing
• 💼 License

---

💾 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