Recently Written · git

sbm-android

sbm bookmarks for Android: fuzzy search, share to add, sync with bm and the browser add-on

git clone https://github.com/equwal/sbm-android

Log | Files | Refs


README.md (4671 bytes)

1 # sbm for Android
2 
3 Your [sbm](https://github.com/equwal/sbm) bookmarks on your phone.
4 
5 <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" width="270" alt="The list of bookmarks"> <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2.png" width="270" alt="A search for unix">
6 
7 How sync looks between bm and the browser add-on:
8 [demo, 80 seconds](https://github.com/equwal/sbm-sync#sbm-sync).
9 
10 - **Search as you type**, with the fuzzy match of fzf. Go opens the first
11   match. Text that is no bookmark opens as an address, or as a web search,
12   as in bm.
13 - **Live preview:** while you search, the page of the first match shows
14   above the list. Press and hold a bookmark, then Preview, to see another
15   one. Tap the address above the preview to open the page. An http page
16   shows with https. Turn the preview off with Page preview in the menu.
17 - **Tap to open**, press and hold to copy or share.
18 - **Share to sbm** from any browser to add the page.
19 - **Sync** with bm on your computers and the sbm add-on for Firefox and
20   Chrome, through an [sbm-sync](https://github.com/equwal/sbm-sync) server.
21 - Or **open a bookmark file** that Syncthing, git or a file app keeps.
22 
23 The bookmarks stay an sbm file: one bookmark per line,
24 `URL<tab>description<tab>tags`.
25 
26 ## Sync
27 
28 In the menu, "Sign in to sync" uses https://sbmsync.com unless you type
29 another server. Create an account on the website of the server. Sync on
30 sbmsync.com is free. You can also [run your own
31 server](https://github.com/equwal/sbm-sync): it is free software.
32 
33 After a sign-in, the app syncs when you open it and after you add a
34 bookmark. Without a file of your own, the app keeps the file in its own
35 storage.
36 
37 ## Privacy
38 
39 The app has no ads, no analytics and no trackers. It uses the network for
40 two things only. Sync, after you sign in, and only with the server that you
41 choose. And the live preview, which loads the page of a bookmark from its
42 site while you search, as a browser does; Page preview in the menu turns it
43 off. See the [privacy policy](https://sbmsync.com/privacy).
44 
45 ## Build
46 
47     ./gradlew assembleDebug testDebugUnitTest
48 
49 JDK 17 or later and the Android SDK (platform 36). The app uses only the
50 Android framework: no AndroidX, no Google libraries.
51 
52 Release builds are signed when `SBM_KEYSTORE_FILE` and
53 `SBM_KEYSTORE_PASSWORD` are set (key alias `sbm`). The Google Play build has
54 no link to Ko-fi, because Google Play does not allow links to payments
55 outside Google Play:
56 
57     ./gradlew bundleRelease -PplayStore=true    # Google Play
58     ./gradlew assembleRelease                   # F-Droid and GitHub
59 
60 ## More projects
61 
62 - [SubRead](https://subread.space/): read along with an audiobook, in the browser.
63   Also [for Android](https://github.com/equwal/subread-android/releases/latest),
64   [for YouTube](https://github.com/equwal/subread-extension/releases/latest)
65   and [for KOReader](https://github.com/equwal/subread.koplugin).
66 - [SubRead Overlay](https://github.com/equwal/subread-overlay/releases/latest): subtitle lines over any Android media player.
67 - [SubRead Dictionary](https://github.com/equwal/subread-dictionary/releases/latest): a pop-up dictionary for Android that reads Yomitan dictionaries.
68 - [SubRead Anki](https://github.com/equwal/subread-anki): one tap makes an Anki card from any Android app.
69 - [Subrep](https://github.com/equwal/subrep-android/releases/latest): live captions of the sound of your phone.
70 - [Book Simulator](https://booksimulator.com/): a reading room for Aozora Bunko and Project Gutenberg books.
71 - [honjimaku.com](https://honjimaku.com/): subtitles for Japanese audiobooks.
72 - [sbm Sync](https://sbmsync.com/): your bookmarks, the same on every device,
73   with [sbm](https://github.com/equwal/sbm) for dmenu,
74   [sbm for Android](https://github.com/equwal/sbm-android/releases/latest)
75   and the [sbm add-on](https://github.com/equwal/sbm-extension/releases/latest) for Firefox and Chrome.
76 - [Rebind](https://github.com/equwal/rebind/releases): remap the hardware buttons of e-ink readers and Android,
77   with [Ink Recents](https://github.com/equwal/ink-recents/releases/latest),
78   [Ink Dim](https://github.com/equwal/ink-dim/releases/latest)
79   and [Ink Update](https://github.com/equwal/ink-update/releases/latest).
80 - [dickt.store](https://dickt.store/): language-learning tools, flashcards and web toys.
81 - [hentaibun.online](https://hentaibun.online/): learn kanbun and kobun.
82 - [Recently Written](https://recentlywritten.com/): the blog, and a list of [all projects](https://recentlywritten.com/projects.html).
83 
84 ## License
85 
86 AGPL-3.0. If sbm is useful to you, you can support it on
87 [Ko-fi](https://ko-fi.com/truex).