From 8784899e25b362c570cb65f671f11e3bfa9685fc Mon Sep 17 00:00:00 2001 From: terminaldweller Date: Wed, 5 Jun 2024 21:42:03 -0400 Subject: cleaned up the code, removed extranneous microservices. hived is a monolith again. using pocketbase for AAA. --- README.md | 60 +----------------------------------------------------------- 1 file changed, 1 insertion(+), 59 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8542d55..7bfb97d 100644 --- a/README.md +++ b/README.md @@ -3,62 +3,4 @@ # hived -`hived` is small personal cryptocurrency server:
- -- It sends notifications through telegram.
- -Currently it has 5 endpoint:
- -### /price - -Lets you ask for the price of the currency. You can determine the currency the value is returned in.
- -### /pair - -Takes in a pair of currencies and a multiplier. Determines and returns the ratio.
- -### /alert - -#### POST - -Takes in a name and a math expression containing the names of the currencies. Checks the expression periodically. Sends a message over telegram when the expression holds true.
-The expression's result must be boolean. As an example:
- -```Go -ETH*50>50000. -ETH*60/(DOGE*300000) < 4. -``` - -You can have as many parameters as you like. The requests for the crypto prices are all turned into individual goroutines so it's fast.
-The expression evaluation is powered by [govaluate](https://github.com/Knetic/govaluate). So for a set of rules and what you can and cannot do please check the documentation over there.
- -#### DELETE - -Deletes the key from the DB so you will no longer receive updates.
- -#### PUT - -Updates the alert.
- -#### GET - -Fetch the alert with the given name.
- -### /ex - -Gets the list of currencies that are available to be traded.
- -You can check under `./test` for some examples of curl commands.
- -### /health - -Returns the health status of the service.
- -```sh -TELEGRAM_BOT_TOKEN="my-telegram-bot-api-key" -``` - -If you want to use docker-compose, it's as simple as running `docker-compose up`. You just need to provide the files. You can check the file names in the docker-compose file.
-Both the server itself and the redis image are alpine-based so they're pretty small.
- -## telebot +`hived` is a cryptocurrency api server:
-- cgit v1.2.3