diff --git a/README.md b/README.md index 0c6c2c2..eb9f244 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,81 @@ -# Website +

+
+ jasima.app +
+

+ +

+ Language: Typescript + + Licence: BSD 2-Clause + + Lifecycle: Experimental +
+ + Website + + + Issues + + + Open Collective backers and sponsors + +

+ +## lipu pali pi ilo jasima + +*Main website and user guide.* This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +A Nix flake is included that allows installation of all the tools required for development. +Deployment happens in a Forgejo action which builds and deploys the result to Netlify. ### Installation -``` -$ yarn +```bash +nix develop --command npm install ``` ### Local Development -``` -$ yarn start +```bash +nix develop --command npm run start ``` -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +This command starts a local development server and opens up a browser window. +Most changes are reflected live without having to restart the server. ### Build -``` -$ yarn build +```bash +nix develop --command npm run docusaurus gen-api-docs api # Generates the OpenAPI documentation +nix develop --command npm run build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. -### Deployment +### Deploy -Using SSH: - -``` -$ USE_SSH=true yarn deploy +```bash +nix develop --command netlify deploy ``` -Not using SSH: +### Copyright -``` -$ GIT_USER= yarn deploy -``` +Copyright © 2022-2025 SR2 Communications Limited. -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the +following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.