From 053ab963235742ce1495c982e6b15a8b18e93502 Mon Sep 17 00:00:00 2001 From: Maddox Werts Date: Tue, 11 Feb 2025 12:01:46 -0500 Subject: [PATCH] Updated README --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9f9b802..4c3288c 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,12 @@ In order to avoid paying **$49.99** A MONTH, this project uses **2 Free APIs** * API Keys and Limits are setup in this project, so feel free to give it to whoever you want. As a suggestion, to create an API key, run the following command to generate one to insert into the *Database*: `openssl rand -base64 24` ## Deploying -This project has a [Docker Image](https://git.objnull.net/NeurontalTeam/-/packages/container/neurostock/latest) available on OBJNULL's Foragejo. However, to make things super simple, I have provided a **Docker-Compose** file for easy and reproducable deployment. +This project has a [Docker Image](https://git.objnull.net/NeurontalTeam/-/packages/container/stockmapi/latest) available on OBJNULL's Foragejo. However, to make things super simple, I have provided a **Docker-Compose** file for easy and reproducable deployment. -First, create a server to store *NeuroStock* on. Run the following commands: +First, create a server to store *StockMAPI* on. Run the following commands: ```bash -wget https://git.objnull.net/NeurontalTeam/NeuroStock/src/branch/main/docker-compose.yml -O ~/docker-compose.yml -wget https://git.objnull.net/NeurontalTeam/NeuroStock/src/branch/main/data/settings.yaml.template -O /srv/conf/settings.yaml +wget https://git.objnull.net/NeurontalTeam/StockMAPI/src/branch/main/docker-compose.yml -O ~/docker-compose.yml +wget https://git.objnull.net/NeurontalTeam/StockMAPI/src/branch/main/data/settings.yaml.template -O /srv/conf/settings.yaml ``` Next, change the Docker-Compose to point towards the **/srv/conf** directory. Inside of that directory, edit the lines that you need to grab API Keys, Update the Database Password, etc. @@ -31,5 +31,5 @@ docker-compose up -d Usage is extremely simple. Just follow the format below and you should be set! Make sure to use the API Key from your provider and ask them to track symbols *(Stocks)* that you want! ```bash -curl 'https://www.neurostock.site/v1?api=[CHANGEME]&symbol=[CHANGEME]' +curl 'https://www.stockmapi.site/v1?api=[CHANGEME]&symbol=[CHANGEME]' ```