diff --git a/README.md b/README.md index 67f6d62..61ac0d4 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,63 @@ -# Protocol -Protocol is a [Tailwind UI](https://tailwindui.com) site template built using [Tailwind CSS](https://tailwindcss.com) and [Next.js](https://nextjs.org). -## Getting started +

+ Lysand Logo +

-To get started with this template, first install the npm dependencies: -```bash -npm install -``` +

+ Lysand Documentation +

-Next, run the development server: +
+ TypeScript logo + React logo + NextJS logo + Docker logo + Bun logo + CSS3 logo + HTML5 logo + Linux logo + TailwindCSS logo +
-```bash -npm run dev -``` +
+ +

+ Lysand on an iPad +

-Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website. +## Technologies -## Customizing +- [**`TypeScript`**](https://www.typescriptlang.org/): A typed superset of JavaScript that compiles to plain JavaScript. +- [**`React`**](https://reactjs.org/): A JavaScript library for building user interfaces. +- [**`Next.js`**](https://nextjs.org/): A React framework for building static and dynamic websites. +- [**`MDX`**](https://mdxjs.com/): Markdown for the component era. +- [**`Zustand`**](https://zustand.surge.sh/): A small, fast, and scalable state management library. +- [**`Framer Motion`**](https://www.framer.com/motion/): A production-ready motion library for React. +- [**`FlexSearch`**](https://flexsearch.net/): A full-text search library for JavaScript. -You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files. +## Installation -## Global search +This project uses [Bun](https://bun.sh) as a package manager. To install the dependencies, run: -This template includes a global search that's powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut. +```bash +bun install +``` + +To start the development server, run: -This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/mdx/search.mjs` file. +```bash +bun dev +``` -## License +## Contributing -This site template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license). +Contributions are welcome! Feel free to open an issue or submit a pull request. -## Learn more +### Licenses -To learn more about the technologies used in this site template, see the following resources: +The code in this repository is licensed under the [MIT License]( +https://opensource.org/licenses/MIT). -- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation -- [Next.js](https://nextjs.org/docs) - the official Next.js documentation -- [Headless UI](https://headlessui.dev) - the official Headless UI documentation -- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation -- [MDX](https://mdxjs.com/) - the official MDX documentation -- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation -- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation -- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation +However, the *documentation text* (including the Markdown files in the `app` directory) is licensed under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/). You are free to share and adapt the text as long as you provide proper attribution. \ No newline at end of file diff --git a/public/screenshots/framed/ipad-home.webp b/public/screenshots/framed/ipad-home.webp new file mode 100644 index 0000000..9bc4c71 Binary files /dev/null and b/public/screenshots/framed/ipad-home.webp differ