diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..607fbe1 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,13 @@ +# [Constnium](https://git.kennel.ml/Anri/Constnium) + +Calculate your own constant based on your first name. + +## What does it do? +Simply take each letter of your first name, associate a constant with it, and multiply the constants together. + +## How do you know all these constants? +Me? So... [Wikipedia](https://en.wikipedia.org/wiki/List_of_mathematical_constants) gave me some answers... + +## This is a real constant...? +To ensure that the constant in your first name is unique, +each letter is set to the power relative to the position of the letter in your first name. diff --git a/README.md b/README.md index 607fbe1..6d6ac11 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,14 @@ Calculate your own constant based on your first name. -## What does it do? -Simply take each letter of your first name, associate a constant with it, and multiply the constants together. +## FAQ +There is a [FAQ here](./FAQ.md) if you want to know more about the project. -## How do you know all these constants? -Me? So... [Wikipedia](https://en.wikipedia.org/wiki/List_of_mathematical_constants) gave me some answers... +## Public demo +[Coming Soon™](#) -## This is a real constant...? -To ensure that the constant in your first name is unique, -each letter is set to the power relative to the position of the letter in your first name. +## Host it yourself +Clone the repo and run `npm run main`. + +### Docker +[Coming Soon™](#) diff --git a/src/utils/readme.js b/src/utils/readme.js index c3de297..199a733 100644 --- a/src/utils/readme.js +++ b/src/utils/readme.js @@ -1,7 +1,7 @@ const fetch = require('node-fetch'); // URL of the repo -const repoURL = 'https://git.kennel.ml/api/v1/repos/Anri/Constnium/contents/README.md'; +const repoURL = 'https://git.kennel.ml/api/v1/repos/Anri/Constnium/contents/FAQ.md'; // Store the data from the repo let data = null;