Skip to content

Commit 7b57940

Browse files
committed
README++ with Sell and History web app screenshots
1 parent 59ef6ea commit 7b57940

File tree

3 files changed

+62
-7
lines changed

3 files changed

+62
-7
lines changed

README.md

+62-7
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,19 @@ Command line interface and web UI to search for books, add them to your stock, s
3434
- [Command line](#command-line)
3535
- [Readline interface](#readline-interface)
3636
- [Lisp REPL](#lisp-repl)
37+
- [Run at startup with Systemd](#run-at-startup-with-systemd)
3738
- [Usage](#usage)
3839
- [Bibliographic search, adding books to your stock](#bibliographic-search-adding-books-to-your-stock)
39-
- [Seeing the stock, pagination](#seeing-the-stock-pagination)
40+
- [Seeing your stock](#seeing-your-stock)
41+
- [Selling books, history](#selling-books-history)
42+
- [History (of sells)](#history-of-sells)
4043
- [Places](#places)
4144
- [Lending books to contacts](#lending-books-to-contacts)
4245
- [Stats](#stats)
4346
- [Settings](#settings)
4447
- [High-level goals](#high-level-goals)
4548
- [i18n](#i18n)
4649
- [Dev](#dev)
47-
- [Creating custom commands for the binary application](#creating-custom-commands-for-the-binary-application)
4850
- [Testing](#testing)
4951
- [Troubleshooting](#troubleshooting)
5052
- [Lisp ?!](#lisp-)
@@ -177,7 +179,7 @@ Description=OpenBookStore
177179
[Service]
178180
Restart=on-failure
179181
WorkingDirectory=/home/you/path/to/repository
180-
# We run the binary: (abstolute path)
182+
# We run the binary: (absolute path)
181183
ExecStart=/home/you/path/to/repository/openbookstore --web --port 4242
182184
User=openbookstore # or an existing user
183185
Type=simple
@@ -200,11 +202,30 @@ use `-f` to follow the logs as they are written.
200202

201203
# Usage
202204

203-
If you use the web app, you should find your way. Below is an overview of the available commands of the terminal interface.
205+
Below is an overview of the available features in the web app and in the terminal interface.
204206

205207
## Bibliographic search, adding books to your stock
206208

207-
You can begin to search for books:
209+
In the web app, go to the "Search" menu on the left.
210+
211+
You can search anything by keywords or by ISBN (you can scan a book in
212+
every search input of OpenBookStore). The search will return the
213+
required bibliographic data (title, author(s), publisher, ISBN…) as
214+
well as the book's price and the cover image. However, these last two
215+
data depend on the datasource you use.
216+
217+
The currently available datasources are:
218+
219+
- french datasource
220+
221+
In addition, for each book found, you will see a little button that tells you if you already have this title in stock, and how many.
222+
223+
Click on the "+1" button to add this book to your stock.
224+
225+
![](web.png)
226+
227+
228+
In the **terminal interface**, use `search`:
208229

209230
- `search <search terms or ISBN>`
210231

@@ -224,9 +245,13 @@ See also
224245

225246
- `delete <i>`
226247

227-
## Seeing the stock, pagination
248+
## Seeing your stock
249+
250+
To search the books you have in stock, use the "Stock" menu in the web
251+
app, or use the search input in the top navigation bar.
228252

229-
To see your stock:
253+
254+
In the **terminal interface**, use `stock`:
230255

231256
- `stock [keyword]`, with an optional keyword you can **filter by titles**.
232257

@@ -246,8 +271,38 @@ As with several commands, you can autocomplete the id argument using
246271
the TAB key. The choices are the ids displayed on the last `stock`
247272
command, so this can be handy when you have filtered the results.
248273

274+
## Selling books, history
275+
276+
In the web app, go to the "Sell" menu.
277+
278+
You can scan any book in the search input that is already selected,
279+
and you can search books already in your stock with the keyboard (3
280+
letters are necessary to trigger a search).
281+
282+
Once you're ready, click a paymenth method button to validate the transaction.
283+
284+
![](sell.png)
285+
286+
What remains to be done:
287+
288+
- register the sell for a client, handle three payment methods, generate a PDF bill…
289+
290+
291+
## History (of sells)
292+
293+
You can find all your sell transactions in the History.
294+
295+
![](history.png)
296+
297+
What remains to be done:
298+
299+
- see the history by month, by day, simple stats…
300+
301+
249302
## Places
250303

304+
*Note: we don't encourage the use of multiple places, it only renders your stock management more difficult*
305+
251306
When you start the program, you are in the "default place". See that
252307
the command prompt displays `(default place) bookshops > `: it shows the
253308
current place you are in.

history.png

76.4 KB
Loading

sell.png

50.9 KB
Loading

0 commit comments

Comments
 (0)