diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..cc7ee1c --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2024 Joel Drapper + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..1b71f93 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# Phlex.fun + +## Contributing + +You may need to [install bun](https://bun.sh/docs/installation) to run this project. Once bun is installed: + +- `cd` into the project directory +- Run `bun install` +- Run `bun run docs:dev` +- Navigate to `http://localhost:5173/` in your browser +- Now you can make changes to the markdown files and when you save, the browser will automatically reload with the changes diff --git a/bun.lockb b/bun.lockb index 87247e1..2df4f1c 100755 Binary files a/bun.lockb and b/bun.lockb differ