Updated README

Author: phillmv

README.md

@@ -6,7 +6,7 @@ This is the source code repository for Arquivo, a note-taking app.
 
 Arquivo seeks to be an archive for your digital artifacts, ephemera, and notes. Its purpose is to help you keep track of your research, tasks, and thoughts, and help you produce better end products (i.e. essays, papers, books, apps).
 
-I currently use this app for daily journaling, keeping track of household information, and all of the notekeeping required to perform my day job as a software engineer.
+I currently use this app for: daily journaling, personal bookmarking, keeping track of household projects, and all of the notekeeping required to perform my day job as a software engineer.
 
 ## Values
 
@@ -16,12 +16,14 @@ Arquivo's design choices and compromises are driven by the following values:
 2. **Durability**. Your data is portable by default, and it should outlive this app.
 3. **Longevity**. You should be able to keep using this app for at least 10+ years.
 
+Data is stored in markdown within a git repository. You will always be able to read your data, move it elsewhere, and revert back to an earlier version.
+
 ## Goals
 
 Arquivo will be a successful project if:
 
 - It can store and search all the digital artifacts I care about.
-- Different users can successfully use their own organization strategies.
+- Different users can successfully use their own organization strategies (bullet journaling, zettelkasten, whatever).
 - Using this app actually leads to better end products (i.e. essays, papers, books, apps).
 
 ## Features
@@ -30,107 +32,58 @@ Arquivo currently supports the following features:
 
 - write notes in markdown
 - attach files to notes
-- create tasks from notes
+- create tasks in notes
 - organize notes by notebook
 - notebooks are automatically serialized to files and folders
 - serialized files are stored in git repos
 - fulltext search
 - search by hashtag or @-mention
 - bookmark websites
 - sync calendars via `.ical` files
-- sync with pinboard
+- browse by week or month
+- search todo lists
+- generate a static website from your notebook
 
 
 ## Installation
-### Dependencies
-
-At the time of writing, very little effort has gone into making the app comfortable for new users. These instructions may be out of date.
-
-I hereby assume you, dear reader, have a certain level of familiarity with ruby, rails, and node. You will need to install:
-
-- Ruby >= 2.6.5
-- Node ~13 or so
-- Yarn 1.22.4
-
-### Setup
-
-```bash
-git clone [email protected]:phillmv/arquivo.git
-
-bundle
-
-yarn install
-
-bundle exec rails db:setup
-
-bundle exec rails c
-```
-
-The app assumes you have a `$HOME/Documents` folder, and will try to create a `$HOME/Documents/arquivo` subdirectory.
-
-Right now, there is no interface for creating notebooks aside from the console. The app assumes there's a Notebook called "journal", and you will want to create a few more at your leisure.
-
-```ruby
-Notebook.create(name: "journal") # default notebook
-
-Notebook.create(name: "work")
-```
-
-Finally, at the moment the user is hardcoded. You will want to edit `app/models/user.rb` to change `def self.name` to point to your user.
-
-### Adding a calendar
+### Mea culpa
 
-```ruby
-CalendarImport.create(notebook: "your-notebook-here",
-                      title: "name-of-calendar",
-                      url: "http://example.com/path-to.ics");
+Unfortunately, I've had no time to make anything easy to use. New users will have to drop into the Rails console and create a new Notebook, and then via the web interface add an ssh key for git syncing to work.
 
-# to manually process it:
-UpdateCalendarsJob.perform_now!
+In the meantime, however, _advanced users_ are encouraged to poke thru the Dockerfile; development & deployment is intended to happen thru the corresponding container image.
 
-```
-
-### Let's go!
-
-Then just start the server:
-
-```bash
-bundle exec rails s
-
-# or
-
-forego start
-```
-
-visit http://localhost:3000/
-
-I _highly_ recommend setting a local hostname of `arquivo.localhost` for your app, and a port 80 redirect via nginx or what have you. Some minor features may not work out of the box otherwise.
+### Getting started
 
-## Import / Export
+Step 1: [Authenticate with the GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic).
 
-Meant to sync notebooks between machines. This works quite well with Dropbox.
+Step 2: The following incantation should be sufficient to get a working dev environment off the ground:
 
 ```bash
-rails runner 'SyncToDisk.export_all!("/your/path/here/arquivo")'
-rails runner 'SyncFromDisk.import_all!("/your/path/here/arquivo")'
+# set up a local copy in, for example, ~/code/arquivo
+git clone [email protected]:phillmv/arquivo.git ~/code
+
+# set up a data folder in, for example, ~/Documents/arquivo
+mkdir -p ~/Documents/arquivo
+
+# boot up the server:
+ARQUIVO_PORT=12346
+export ARQUIVO_USER=your_user_here
+export [email protected]
+export ARQUIVO_GIT_NAME="Your Name"
+export RAILS_ENV=development
+export RAILS_MASTER_KEY=DUMMY
+export RAILS_BIND=tcp://0.0.0.0:3001
+
+docker run -it -p "$ARQUIVO_PORT":3001 \
+  -e ARQUIVO_USER \
+  -e ARQUIVO_GIT_EMAIL \
+  -e ARQUIVO_GIT_NAME \
+  -e RAILS_ENV \
+  -e RAILS_MASTER_KEY \
+  -e RAILS_BIND \
+  -v ~/Documents/arquivo/:/data \
+  -v ~/code/arquivo:/arquivo \
+  ghcr.io/phillmv/arquivo-development:latest
 ```
 
-To automatically sync to a git remote, open a terminal, `cd $HOME/Documents/arquivo/your-notebook-here` and add a remote to the repository, i.e. `git remote origin add URLHERE`.
-
-## Developing
-
-You can install Ruby, Node etc locally OR
-
-you can use the provided `nix-shell` configuration.
-
-### Using nix-shell for development
-
-* install the nix package manager https://nixos.org/download.html - if you are on MacOS Catalina see https://gist.github.com/ghedamat/25c671a02923dbac6c140afe54276f9e
-* type `nix-shell` in the root of this project
-* you are now in a `bash` shell that has all the required dependencies, type `bundle` and you'll be good to go
-
-### Customizing the hostname
-
-```
-echo "HOSTNAME=arquivo.localhost" >> .env.development
-```
+This should bind a webserver to http://localhost:12346/ , and off you go. Consult this repository for the Dockerfile. A production image is published to `ghcr.io/phillmv/arquivo`.