Skip to content

Update README.md for grammar #595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
apokusin wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update README.md for grammar #595

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bd8638d
Update README.md for grammar
apokusin Aug 1, 2025
965cbb6
Merge branch 'main' into fix/readme-grammar
apokusin Aug 5, 2025
cf996c7
Merge branch 'main' into fix/readme-grammar
apokusin Aug 5, 2025
d9b4752
Merge branch 'main' into fix/readme-grammar
apokusin Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Or browse all versions at [GitHub releases](https://github.com/EternisAI/enchant
- Add custom MCP servers (stdio, remote) `beta`
- Advance memory (fact extraction, memory consolidation, embedding search)
- Support for local embeddings (JinaAI)
- Support for local anonymiser model `pre-release`
- Support for local anonymizer model `pre-release`
- Data Imports (WhatsApp, ChatGPT, Telegram, Slack, Google-Gmail, X, Local Files) `beta`
- Voice mode and Voice onboarding `beta`
- Global omnibar
Expand All @@ -39,22 +39,22 @@ Or browse all versions at [GitHub releases](https://github.com/EternisAI/enchant

## AI privacy levels

What gives Enchanted the right to exist is a tremendous focus on privacy. Official release of Enchanted uses a combination of local models, open sources models in a Trusted Execution Environment as well as closed source models behind a privacy proxy.
What gives Enchanted the right to exist is a tremendous focus on privacy. Official release of Enchanted uses a combination of local models, open-source models in a Trusted Execution Environment, as well as closed-source models behind a privacy proxy.

- Requests to closed source models are proxied through a router running in a trusted execution environment, ensuring that closed source model providers cannot match requests to users.
- Requests to closed-source models are proxied through a router running in a trusted execution environment, ensuring that closed-source model providers cannot match requests to users.
- The embeddings model runs locally on the user's device.
- Voice models run in a trusted execution environment.
- Anonymiser model is running locally on the user's device. `beta` (Coming soon)

Main codebase for Enchanted is open source and available on [GitHub](https://github.com/eternisai/enchanted-twin). In addition the proxy codebase can be found [here](https://github.com/EternisAI/enchanted-proxy) while the attestation proxy exposing cryptographic attestation documents generated by the Nitro Hypervisor for AWS Nitro Enclaves can be found [here](https://github.com/EternisAI/attestation-proxy).

Developers on the other hand can chose one of many ways of using AI Completions and Embeddings in Enchanted depending on the privacy requirements.
Developers, on the other hand, can choose one of many ways of using AI Completions and Embeddings in Enchanted, depending on the privacy requirements.

## Connectivity & Integrations

### Data Sources `beta`

Enchanted supports many predefined data sources to ingest data from. These data sources
Enchanted supports many predefined data sources for data ingestion. These data sources
can be used to build the memory for your agent about you. All imported data is stored
locally on the user's device.

Expand All @@ -71,7 +71,7 @@ Enchanted comes with built-in support for popular services:
- **Slack**: Team communication and workflow
- **Screenpipe**: Screen and audio capture analysis

Users can also add custom MCP servers following stdin or remote protocol.
Users can also add custom MCP servers using either stdin or a remote protocol.

![Data Sources Screenshot 1](https://i.ibb.co/ycKSB4tL/Xnapper-2025-07-28-19-29-43.jpg?cb=1)

Expand Down Expand Up @@ -108,7 +108,7 @@ Instantly open the Omnibar from any application with <kbd>⌘</kbd> + <kbd>⌥</

### Keyboard Shortcuts

Set custom keyboard shortcuts for your most used actions.
Set custom keyboard shortcuts for your most-used actions.

![Keyboard Shortcuts Screenshot](https://i.ibb.co/t6zzQgF/Xnapper-2025-07-28-20-19-37.jpg?cb=2)

Expand Down Expand Up @@ -170,10 +170,10 @@ Common development commands:

Backend

On the backend side GraphQL resolvers (`schema.resolvers.go`) are code-generated from the schema `schema.graphqls`. Steps to update the schema
On the backend side, GraphQL resolvers (`schema.resolvers.go`) are code-generated from the schema `schema.graphqls`. Steps to update the schema

1. Propose schema changes in `schema.graphqls`.
1. Generate resolvers using `make gqlgen` in `backend/golang` directory.
1. Generate resolvers using `make gqlgen` in the `backend/golang` directory.
1. This will generate additional code in `schema.resolvers.go`.

Frontend
Expand All @@ -182,7 +182,7 @@ Frontend uses `schema.graphqls` as the source of truth to code generate queries/

## Troubleshooting

- If you see a database (either SQLite or Weaviate) delete local directory `output` for testing.
- If you see a database (either SQLite or Weaviate), delete the local directory `output` for testing.

- Application data on Mac is `~/Library/Application Support/enchanted`

Expand Down
Loading