diff --git a/README.md b/README.md index 6d0aba2..0ca4434 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,26 @@ It also can import/export to csv files or local storage. - Saving is open to the public. - The saved links are private and saved in the browser local storage of the users. - ## Install +## Features +- Add/Delete links +- Search +- Tags +- Bookmarklet (useful for a 2-click-save) +- Data reads from: + - csv file in server (these links are public) + - local storage in browser (these links are visible just for the user) +- Local storage saving. +- Import to local storage from csv file +- Export to csv from local storage. +- Export to csv from csv file (useful when links are "deleted" using the app and just hidden using a local storage blacklist). +- Export to csv from both places. +- No external libraries. +- Vanilla css code. +- Vanilla js code. + +## Install -#### BASIC INSTALL +#### BASIC INSTALL (3min) - Copy the contents of this repository to an online directory. That's all. You can start saving links. #### SHOWCASE YOUR LINKS @@ -39,7 +56,7 @@ It also can import/export to csv files or local storage. - Add > Bulk Transfer > Paste the contents. #### CREATE BOOKMARKLET -To be able to easily save bookmarks create a bookmarklet: +To be able to easily save bookmarks with the form prefilled, create a bookmarklet: - In your browser, create a new bookmark with "add woomark" () as Name - Paste the next code as URL. ``` @@ -60,22 +77,6 @@ window.open(`https://YOURDOMAINGOESHERE.com/?title=${title}&url=${url}`, '_blank ![screenshot](screenshot_appcode.png) -## Features -- Add/Delete links -- Search -- Tags -- Bookmarklet (useful for a 2-click-save) -- Data reads from: - - csv file in server (these links are public) - - local storage in browser (these links are visible just for the user) -- Local storage saving. -- Import to local storage from csv file -- Export to csv from local storage. -- Export to csv from csv file (useful when links are "deleted" using the app and just hidden using a local storage blacklist). -- Export to csv from both places. -- No external libraries. -- Vanilla css code. -- Vanilla js code. ## Design This design is inspired by Pocket's UI, which was very good for showing a list of articles to read later. Native bookmarking feels more utilitarian, suited for recurrent links, woomarks is more suited for read later links.