docs: update readme

README.md

@@ -2,3 +2,30 @@
 
 This is an MUD ([Multi User Dungeon](https://en.wikipedia.org/wiki/Multi-user_dungeon)) client,
 designed to be cross platform for both mobile and desktop.
+
+## Development
+
+1. Install [Flutter](https://docs.flutter.dev/get-started/install)
+1. Clone this repo
+1. Copy `lib/core/secrets.example.dart` to `lib/core/secrets.dart`, and make the modifications as
+   specified in the file comments. The secrets are ignored on git for security reasons for users of
+   this app via official channels.
+1. Run `flutter run` to start developing on an emulator or a connected device
+
+> This app is in early development stages and things are very likely to change and break with
+> updates.
+
+## Contributing
+
+I am developing this package on my free time, so any support, whether code, issues, or just stars is
+very helpful to sustaining its life. If you are feeling incredibly generous and would like to donate
+just a small amount to help sustain this project, I would be very very thankful!
+
+<a href='https://ko-fi.com/casraf' target='_blank'>
+  <img height='36' style='border:0px;height:36px;'
+    src='https://cdn.ko-fi.com/cdn/kofi1.png?v=3'
+    alt='Buy Me a Coffee at ko-fi.com' />
+</a>
+
+I welcome any issues or pull requests on GitHub. If you find a bug, or would like a new feature,
+don't hesitate to open an appropriate issue and I will do my best to reply promptly.

lib/core/features/action.dart

@@ -72,13 +72,15 @@ class MUDAction {
   String _doSpecialReplacements(GameStore store, String content) {
     debugPrint('MUDAction._doSpecialReplacements: $content');
     content = content
-            .replaceAll('%PASSWORD', store.currentProfile.password)
-            .replaceAll('%USERNAME', store.currentProfile.username)
-        //
-        ;
+        .replaceAll('%PASSWORD', store.currentProfile.password)
+        .replaceAll('%USERNAME', store.currentProfile.username);
+
+    // variables from the store
+    // TODO allow disabling this
     for (final vari in store.variables.values) {
       content = content.replaceAll('%${vari.name}', vari.value);
     }
     return content;
   }
 }
+

lib/core/features/automation.dart

@@ -30,6 +30,7 @@ class Automation {
     this.invokeCount = 0,
   });
 
+  /// is both enabled (globally by the user) and not temporarily disabled (by the automation itself)
   bool get isAvailable => enabled && !tempDisabled;
 
   factory Automation.empty() => Automation(