diff --git a/README.md b/README.md index 44b43cb..9374a47 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ By using existing prime factorization libraries such as primecount and msieve, t Everything in this program and document is set to change at any moment depending on needs. # Usage -Solsys Server is the only currently (rudimentarily) operational part of this program. There are two files of note: `factors.js` and `cmd.js`. `factor.js` is a node module that does all of the heavy lifting and processing by running `primecount` and `msieve` executables in separate child process. The executables can be found in `server/factorization-dependencies/`. `cmd.js` is a node program which allows you to run the module a total of once with command line arguments. +## Solsys Standalone +Solsys Standalone runs locally on the client's computer, and is located in solsys/server. It contains two files of note: `factor.js` and `cmd.js`. `factor.js` is a node module that does all of the heavy lifting and processing by running `primecount` and `msieve` executables in separate child process. The executables can be found in `server/factorization-dependencies/`. `cmd.js` is a node program which allows you to run the module a total of once with command line arguments. The command line arguments are as follows: `-n ` (REQUIRED & ONLY FOR cmd.js) Tells cmd.js the number you want to factorize. @@ -14,4 +15,12 @@ The command line arguments are as follows: `-d ` The minimum number for which to find π(\). Defaults to 999999. `-v` Runs the program in VERBOSE mode, akin to debug mode for now. `-l` Runs the program with linux command line arguments, necessary to run on linux. -`-r` Runs the program with a random 50 digit number. \ No newline at end of file +`-r` Runs the program with a random 50 digit number. + +## Solsys Lambda +Solsys Lambda is stripped-down and specially compiled derivative of Solsys Standalone that runs on Amazon Web Services' "Lambda" and "API Gateway" products. It can be accessed through a GET request to the following endpoint: +`https://n3dl2qh6kj.execute-api.us-west-2.amazonaws.com/prod/factorize/?number=` +A special header, "`x-api-key`", needs to be set to the value "`LtXAQm6tm05M7sd42Tcl72fyF328LCWd3wrXvWHM`" in order to be properly authenticated for this AWS API Gateway endpoint. + +An example of obtaining the factorization for the number 234 through curl is as follows: +`curl -H "x-api-key: LtXAQm6tm05M7sd42Tcl72fyF328LCWd3wrXvWHM" https://n3dl2qh6kj.execute-api.us-west-2.amazonaws.com/prod/factorize/?number=234` \ No newline at end of file