diff --git a/README.md b/README.md index a82ba52..77970d7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,61 @@ -# Textual Tool for Creating Member Profiles for python.pe +# 🐍 edit-python.pe +## *Textual Tool for Creating Member Profiles for python.pe* -To run this tool, just type: -```sh -uvx edit-python-pe + +## ⚑ **QUICK START** + +> **πŸ”₯ Welcome to the future!** This tutorial will guide you step-by-step to create your profile on python.pe quickly and securely. + +### πŸ”§ **PREREQUISITES** + +```bash +# Check required versions +python --version # >= 3.13 +uv --version # >= 0.8.11 +``` + +> ** ⚠️ IMPORTANTE: ** AsegΓΊrese de que todas las dependencias estΓ©n actualizadas antes de continuar. + + +## 🎯 **INSTALLING edit-python.pe** + +### **Creating the access token** + +1. Generate a [Personal access token (classic)](https://github.com/settings/tokens). +2. Grant the scope: `public_repo`. +3. Copy the token and keep it handy for the command below + + +### 🌟 **For users seeking maximum speed** + +```bash +# πŸš€ Single command to start the project +uvx edit-python-pe + +# 🎊 That's it! You can now enter your data ``` -After that, a text user interface would appear that allows you to create your -profile and push it (create a PR) to the -[python.pe](https://github.com/pythonpe/python.pe) repository. + + + + +
+ +## 🎊 **CONGRATULATIONS!** + +### *You've completed the process* + +![Success](https://img.shields.io/badge/STATUS-INSTALLATION%20SUCCESS-00ff88?style=for-the-badge&logo=checkmarx&logoColor=white) + +**🀝 Contribute to the project** β€’ **πŸ› Report bugs** β€’ **πŸ’‘ Suggest improvements** β€’ **⭐ Give us a star** + +#### Built with ❀️ by the python.pe team + +
+ +--- + +
+πŸ“‹ Tutorial version: v1.0.0 +