This repo now only contains the web app.

I did this because they are 2 separate concerns and I have diverged
so far from the original repo. I didn't start a new repo because it
contains valuable history of all the people who contributed to it.

Additionally if there is an issue with this we can revert, but I
rather not. Forks are forks.

README.md

@@ -1,23 +1,62 @@
+# Damus Web 
 
-# damus.io
+Here lies the code for the Damus web app, a client for the Nostr protocol. The
+goal of this client is to be a better version of Twitter, but not to reproduce
+all of it's functionality.
 
-The damus.io website
+[Issue Tracker](https://todo.sr.ht/~tomtom/damus-web-issues)
 
-## Damus Web
+## Roadmap
 
-You can find the damus web app in the `web` directory
+Here is what is confirmed for development.
 
-## Contributing
+ - [ ] Share event
+ - [ ] Profile view (with ability to follow user)
+ - [ ] Edit metadata (from profile view)
+ - [ ] Global timeline view
+ - [ ] Notifications view
+ - [ ] Settings view (with ability to configure relays)
+ - [ ] Multiple reaction picker
+ - [ ] Direct Messages (subject to discussion)
 
-You can send me patches over nostr or [email][email] at jb55@jb55.com
+## Contribution Guide
 
-You can also just hit me up with a git-request-pull and ask me to pull one of
-your branches. eg, from github:
+There are rules to contributing to this client. Please ensure you read them 
+before making changes and supplying patch notes.
 
-    git request-pull origin/master https://github.com/bob/my-damus-io-fork
+ - No transpilers. All source code should work out of the box.
+ - Keep source code organised. Refer to the folder structure. If you have a
+   question, ask it.
+ - Do not include your personal tools in the source code. Use your own scripts
+   outside of the project. This does not include build tools such as Make.
+ - Use tabs & write JS with snake_case. End of discussion.
+ - Do not include binary files.
+ - No NPM (and kin) environments. If you need a file from an external resource
+   mark the location in the "sources" file and add it to the repo.
+ - No frameworks. Learn the browser tools and write good code. 
+ - No experimental browser APIs.
+ - Do not write animations in JavaScript, CSS only. Keep them short and snappy.
+   Animations should not be a forefront, but an enjoyable addition.
+ - All new & modified code should be properly documented.
+ - Source code should be readable in the browser.
 
-If you email or nostr me the output of this command I will be able to review &
-merge your changes!
+These rules are subject to discussion.
+
+## Style Guide
+
+TODO Write about the style guide.
+
+## Terminology
+
+ * Sign Out  - Not "log out", "logout", "log off", etc.
+ * Sign In   - Not "login", "log in", "signin", "sign-in", etc.
+ * Share     - Not "boosted", "retweeted", "repost", etc.
+ * Send      - Not "tweet", "toot", "post", etc.
+ * Link      - Not "share".
+
+## Known Issues 
+
+ * You cannot send events when running from an IP address that is not secure. 
+   Work arounds are not known at this time.
 
-[email]: https://git-send-email.io/