Permalink
Browse files

Mention the documentation in the main README file.

Also, don't provide the docs/ directory in the release file.
  • Loading branch information...
rjuju committed Mar 24, 2018
1 parent 425a3ad commit 89cbea70500eb440b2074deabda45ac06923d524
Showing with 8 additions and 3 deletions.
  1. +1 −0 Makefile
  2. +7 −3 README.md
@@ -16,6 +16,7 @@ release-zip: all
unzip ./hypopg-$(EXTVERSION).zip
rm ./hypopg-$(EXTVERSION).zip
rm ./hypopg-$(EXTVERSION)/.gitignore
rm ./hypopg-$(EXTVERSION)/docs/ -rf
rm ./hypopg-$(EXTVERSION)/typedefs.list
rm ./hypopg-$(EXTVERSION)/TODO.md
sed -i -e "s/__VERSION__/$(EXTVERSION)/g" ./hypopg-$(EXTVERSION)/META.json
@@ -7,8 +7,12 @@ An hypothetical, or virtual, index is an index that doesn't really exists, and
thus doesn't cost CPU, disk or any resource to create. They're useful to know
if specific indexes can increase performance for problematic queries, since
you can know if PostgreSQL will use these indexes or not without having to
spend resources to create them. For more information on this extension usage,
you can see [this blog
spend resources to create them.

For more thorough informations, pease consult the [oficial
documentation](https://hypopg.readthedocs.io).

For other general informations, you can also consult [this blog
post](https://rjuju.github.io/postgresql/2015/07/02/how-about-hypothetical-indexes.html).

Installation
@@ -23,7 +27,7 @@ Installation
Usage
-----

NOTE: The hypothetical indexes are contained in a single backend. Therefeore,
NOTE: The hypothetical indexes are contained in a single backend. Therefore,
if you add multiple hypothetical indexes, concurrent connexions doing
EXPLAIN won't be bothered by your hypothetical indexes.

0 comments on commit 89cbea7

Please sign in to comment.