Update README with more project details.

This commit is contained in:
Hyperling 2025-04-25 06:12:22 -07:00
parent df39fd1a0e
commit 0064425128

16
README.md Normal file → Executable file
View File

@ -1,3 +1,15 @@
# python-buddy-api
# "Buddy", the Django API and Slack Bot
The 2018 implementation of the Buddy API used in a Slack chat. Written in Django. Added to archives 2025-04-25.
The 2018 implementation of the Buddy API used in a Slack chat.
Written in Django. Added from archives 2025-04-25.
Project was placed directly in the `/root/` folder of a container. The old crontab
does not have specific instructions on how to start the server, there was likely
a service which handled that. My 2025 guess after not using Django for 6 years
would be that `bin/init_python.sh` and `bin/init_buddy_walk.sh` were run, or at
least that is what was used to test locally.
Tried getting it to run and provide more context in this README as to how the
projet can be installed and operated, but not looking to set up Django at this
time, just going to use the repo as a reference when rewriting in a different
language.