Update

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[naden@harana.com](mailto:naden@harana.com).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+
+# Welcome to our Contributing Guide
+
+Thank you for investing your time in contributing to our project!
+
+Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
+
+This guide will provide an overview of the contribution workflow, including opening an issue, creating a pull request (PR), and the review and merge process.
+
+## Getting Started
+
+### Issues
+
+#### Creating a New Issue
+
+If you come across an issue or have a feature request, please [search if a related issue has already been reported](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If no relevant issue exists, you can open a new issue using the appropriate [issue form](https://github.com/harana/search/issues/new/choose).
+
+#### Solving an Issue
+
+To find an issue that interests you, you can browse through our [existing issues](https://github.com/harana/search/issues) and use the available `labels` to narrow down your search (See [Labels](https://github.com/harana/search/labels) for more information). As a general rule, if you find an issue you want to work on, you are welcome to open a PR with a fix.
+
+### Making Changes
+
+#### Making Changes Locally
+
+
+### Pull Request
+
+Once you have finished making your changes, create a pull request (PR) to submit them.
+
+- Fill out the "Ready for review" template to help reviewers understand your changes and the purpose of your PR.
+- If you are addressing an existing issue, don't forget to [link your PR to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
+- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so that the branch can be updated for merging.
+- Once you submit your PR, a team member will review your proposal. They may ask questions or request additional information.
+- You may be asked to make changes before the PR can be merged, either through [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. For other changes, you can make them in your fork and commit them to your branch.
+- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
+- If you run into any merge issues, refer to this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues.
+
+### Your PR is Merged!
+
+Congratulations! 🎉🎉 The search team thanks you for your contribution! ✨
+
+Once your PR is merged, your changes will be included in the next release of the application.
+
+## Technologies
+
+### Engine
+
+* [Tantivy](https://github.com/quickwit-oss/tantivy) - Search engine library
+
+
+### Frontend
+
+* [Tauri](http://tauri.app) - Rust version of Electron
+* [Scala.js](https://www.scala-js.org) - Scala version of Typescript
+* [Slinky React](http://slinky.dev) - UI framework
+* [Diode](https://github.com/suzaku-io/diode) - state management
+
+## Dependencies
+
+- [sdk](https://github.com/harana/sdk) - Shared models
+- [search-engine](https://github.com/harana/search-engine) - Core indexing, searching etc Rust crates. 
+- [web](https://github.com/harana/web) - Shared React 

README.md

@@ -1 +1,74 @@
-# search
+<h3 align="center">
+Search everything, instantly.
+</h3>
+
+<p align="center">
+  <img width="600" src="docs/assets/screenshot.png" alt="Screenshot">
+</p>
+
+<p align="center">
+  <a href="https://www.spacedrive.com/api/releases/desktop/stable/darwin/aarch64">macOS Apple</a> ·
+  <a href="https://www.spacedrive.com/api/releases/desktop/stable/darwin/x86_64">macOS Intel</a> ·
+  Windows ·
+  Linux
+  <br />
+  <b>Alpha Release</b>. Expect bugs and crashes.
+</p>
+
+
+## Features
+
+<b>Fast and Minimal</b>
+* Search your desktop and the cloud in < 10ms.
+* CPU usage and temperature aware.
+* Offline - ideal for travellers and VPN users.
+
+<br />
+
+<b>Elegant Interface</b>
+* 700+ file types recognised and categorised.
+* Navigable entirely from keyboard.
+* Information cards for showing thumbnail, file information and more.
+* Instant preview for 15+ file types with more being added.
+
+
+<br />
+
+<b>Powerful Indexing</b>
+* 100s of file types with custom indexing and thumbnail generation.
+* PDF and Image OCR using Google Tesseract. 
+* Text summarisation using Google Bert.
+* Speech to text indexing for movies, podcasts etc using OpenAI Whisper.
+* Image object detection using YOLO.
+* Fallback to macOS Quicklook when needed. 
+
+## Privacy
+
+* We do not track your behaviour or capture any telemetry or user analytics.
+* All searches and file indexing is done locally and never shared.
+* For cloud searches e.g. Notion we do build a searchable index on our servers. But it is encrypted and only readable by you. 
+* We do use Sentry for crash reporting however this can be disabled.
+
+## Vision
+
+Over the coming decades AI is expected to put many people out of work. 
+
+If we want to fight back then we need to make people more productive. And that starts with getting you the information you need as quickly as possible. 
+
+We see a free, open source, community-driven desktop app as being the first step in this journey. We are starting with search but over time want to have an open ecosystem of third party plugins that extends it in ways we couldn't even imagine.
+
+
+## Roadmap
+
+* Developer search e.g. Crates, NPM, Maven. 
+* Windows and Linux support.
+* WebAssembly plugin SDK for indexing, thumbnail generation etc.
+* AdaptiveCard support to allow publishing cards into Teams, Windows Feed etc.
+
+## Developer Guide
+
+Please refer to the [contributing guide](CONTRIBUTING.md) for how to install and contribute.
+
+## Security Policy
+
+Please refer to the [security policy](SECURITY.md) for information on how to responsibly report a security vulnerability or issue.

SECURITY.md

@@ -0,0 +1,7 @@
+# Security Policy
+
+## Reporting a vulnerability
+
+If you find a vulnerability within the app, please report it to us. You may do so anonymously, or we can credit you for it if you wish.
+
+The best way to report any vulnerability or security issue is to email us at [naden@harana.com](mailto:naden@harana.com).