updating README
This commit is contained in:
parent
5fc948a617
commit
ca4b92a6bf
1 changed files with 36 additions and 1 deletions
37
README.md
37
README.md
|
@ -1,3 +1,38 @@
|
|||
# voipsms
|
||||
|
||||
Python flask app that uses voip.ms to manage a number of DID numbers for SMS. Can be used to get mostly anonymous texts and sms verification.
|
||||
Python flask app that uses voip.ms to manage a number of DID numbers for SMS. Can be used to get mostly anonymous texts and sms verification.
|
||||
|
||||
## How to use
|
||||
|
||||
1. Clone the repo
|
||||
|
||||
`git clone http://git.community.i2p/anons-voip/voipsms.git && cd voipsms`
|
||||
|
||||
2. Create and activate a python venv
|
||||
|
||||
`python3 -m venv venv && source ./venv/bin/activate`
|
||||
|
||||
3. Install requirements
|
||||
|
||||
`pip install -r requirements.txt`
|
||||
|
||||
4. Set your config
|
||||
|
||||
`vim config.json`
|
||||
[Read about how to set up your config here!](./README.md#Config)
|
||||
|
||||
5. Start up the server
|
||||
|
||||
`./run`
|
||||
|
||||
## Config
|
||||
|
||||
The config used in this project uses the JSON format and expects a `username` and `password`
|
||||
|
||||
Ex:
|
||||
```
|
||||
{
|
||||
"username":"voipms-email",
|
||||
"password":"voipms-api-password"
|
||||
}
|
||||
```
|
Loading…
Reference in a new issue