Skip to content

Commit

Permalink
Update README and AUTHORS.
Browse files Browse the repository at this point in the history
Kind of a test commit, but I also want to make the README a bit prettier.

Per #2 (comment),
I'm adopting this project. Thanks for your good maintainership and
original work, @dsboger! I'll try and take good care of Zimsearch.
  • Loading branch information
achadwick committed Jun 9, 2017
1 parent 8194b5e commit 56a32fb
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 29 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
/.pydevproject
/.settings/
build
*~
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
- Davi da Silva Böger <dsboger [at] gmail [dot] com>
- Andrew Chadwick <[email protected]>
29 changes: 0 additions & 29 deletions README

This file was deleted.

37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Zimsearch

Authors: Davi da Silva Böger, Andrew Chadwick
GitHub: <https://github.com/achadwick/zimsearch>

Zimsearch is a simple proof-of-concept implementation of a GNOME Shell
search provider for Zim pages.

**THIS IS VERY EARLY ALPHA SOFTWARE. USE AT YOUR OWN RISK**

## Installation

See [INSTALL][] for installation instructions.

## Usage

Search terms typed in the GNOME Shell overview are used to look up Zim
pages from your notebooks. Page titles are matched against the search
terms and only pages that contain all the terms are shown. By default,
all notebooks are searched, but there is a plugin setting to limit the
search to the default notebook only.

It is also possible to limit the search to a certain notebook by adding
a term preceded by a hash sign (`#`). Only notebooks whose names contain
all the `#` terms are searched.

New pages can be created by typing a complete page title, a little like
[nvPY][]. By default the new page goes into your default notebook, but you
can select others with `#` terms as above.

## Bugs

Please file bug reports or feature requests in github issue tracker.

[INSTALL]: INSTALL
[nvPY]: https://github.com/cpbotha/nvpy

0 comments on commit 56a32fb

Please sign in to comment.