diff --git a/README.md b/README.md index 9d1b0c7a..86202a60 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Semantic Search === > Provide natural language search on user personal content like notes, images using ML models -All data is processed locally. User can interface with semantic-search app via [Emacs](https://github.com/debanjum/emacs-semantic-search), API or Commandline +All data is processed locally. User can interface with semantic-search app via [Emacs](./interface/emacs/semantic-search.el), API or Commandline Dependencies ---- @@ -38,9 +38,9 @@ Run Use --- - - *Calls Semantic Search via Emacs* - - `M-x semantic-search ""` - - `C-c C-s` + - *Semantic Search via Emacs* + - [Install](https://github.com/debanjum/semantic-search/tree/master/interface/emacs#installation) [semantic-search.el](./interface/emacs/semantic-search.el) + - Run `M-x semantic-search ""` or Call `C-c C-s` - *Call Semantic Search via API* - `GET` [http://localhost:8000/search?q="What is the meaning of life"](http://localhost:8000/search?q=%22what%20is%20the%20meaning%20of%20life%22) diff --git a/interface/emacs/semantic-search.el b/interface/emacs/semantic-search.el index 0532026d..4ff5be0b 100644 --- a/interface/emacs/semantic-search.el +++ b/interface/emacs/semantic-search.el @@ -4,8 +4,8 @@ ;; Author: Debanjum Singh Solanky ;; Version: 0.1 -;; Keywords: search, org-mode, outlines, ledger -;; URL: http://github.com/debanjum/emacs-semantic-search +;; Keywords: search, org-mode, outlines +;; URL: http://github.com/debanjum/semantic-search/interface/emacs ;; This file is NOT part of GNU Emacs. @@ -26,8 +26,8 @@ ;;; Commentary: -;; This package enables semantic search on org-mode, beancount files -;; It is a wrapper package that interfaces with a transformer based ML model +;; This package provides semantic search on org-mode files +;; It is a wrapper that interfaces with transformer based ML model ;; The models semantic search capabilities are exposed via an HTTP API ;;; Code: