Skip to content

Commit 5085344

Browse files
committed
Update README.md
1 parent 1e59e4e commit 5085344

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

docs/README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
# Free MongoDB GUI powered by PHP
22

33
Visually administrate your MongoDB database. Create, read, update & delete your documents.<br>
4-
Query your MongoDB database with SELECT SQL statements. You can also create & drop indexes.<br>
5-
Autocompletion is available for fields, MongoDB & SQL keywords via `Ctrl` `Space` combination.<br>
4+
Query your Mongo database with SELECT SQL statements. You can also create & drop indexes.<br>
5+
Autocompletion is available for collection fields, MongoDB & SQL keywords via [key shortcuts](#key-shortcuts).<br>
66
Additional features: Export documents to JSON. Import documents from JSON. Manage users.
77

8-
Screenshots
9-
-----------
8+
## Screenshots
109

1110
![MongoDB PHP GUI - Visualize Database](https://raw.githubusercontent.com/SamuelTS/MongoDB-PHP-GUI/master/docs/screenshots/mpg-visualize-database.png)
1211

1312
![MongoDB PHP GUI - Query Database](https://raw.githubusercontent.com/SamuelTS/MongoDB-PHP-GUI/master/docs/screenshots/mpg-query-database.png)
1413

1514
![MongoDB PHP GUI - Manage Indexes](https://raw.githubusercontent.com/SamuelTS/MongoDB-PHP-GUI/master/docs/screenshots/mpg-manage-indexes.png)
1615

17-
Installation
18-
------------
16+
## Installation
1917

2018
### Docker (PHP built-in server)
2119
1. Execute `docker run --rm -p 5000:5000 samueltallet/mongodb-php-gui`<br>
@@ -31,12 +29,17 @@ Installation
3129
6. Optionnaly, if you want to query DB with SQL, you must have [Java JDK](https://jdk.java.net/) installed.
3230
7. Open your browser at Apache server URL to access GUI.
3331

34-
Credits
35-
-------
32+
## Usage
33+
34+
### Key Shortcuts
35+
36+
<kbd>Ctrl + Space</kbd> Autocomplete the query<br>
37+
<kbd>Ctrl + Enter</kbd> Find doc(s) matching the query
38+
39+
## Credits
3640

3741
This GUI uses [Limber](https://github.com/nimbly/Limber), [Capsule](https://github.com/nimbly/Capsule), [Font Awesome](https://fontawesome.com/), [Bootstrap](https://getbootstrap.com/), [CodeMirror](https://github.com/codemirror/codemirror), [jsonic](https://github.com/jsonicjs/jsonic), [JsonView](https://github.com/pgrabovets/json-view), [MongoDB PHP library](https://github.com/mongodb/mongo-php-library), [vis.js](https://github.com/visjs) and [SQL to MongoDB Query Converter](https://github.com/vincentrussell/sql-to-mongo-db-query-converter). Leaf icon was made by [Freepik](https://www.freepik.com) from [Flaticon](https://www.flaticon.com).
3842

39-
Copyright
40-
---------
43+
## Copyright
4144

4245
© 2021 Samuel Tallet

0 commit comments

Comments
 (0)