Merge pull request #60 from iLPdev/main

Full Revert to 0.1.3-alpha State

Author: iLPdev

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -0,0 +1,68 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/sublimetext
+# Edit at https://www.toptal.com/developers/gitignore?templates=sublimetext
+
+### SublimeText ###
+# Cache files for Sublime Text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# Workspace files are user-specific
+*.sublime-workspace
+
+# Project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using Sublime Text
+*.sublime-project
+
+# SFTP configuration file
+sftp-config.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+Package Control.merged-ca-bundle
+Package Control.user-ca-bundle
+oscrypto-ca-bundle.crt
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+
+# End of https://www.toptal.com/developers/gitignore/api/sublimetext
+
+# Created by https://www.toptal.com/developers/gitignore/api/windows
+# Edit at https://www.toptal.com/developers/gitignore?templates=windows
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/windows

README.md

@@ -1 +1,25 @@
-the xml module will live here
+# discMapper Mudlet Module
+
+For developers, this [Mudlet Module](https://wiki.mudlet.org/w/Mudlet_Packages#What_is_a_Mudlet_module) file allows live git updates to your cloned repositories from withtin Mudlet's editor! 
+You should also be ale to use the same cloned XML file across multiple Mudlet profiles simultaneously.
+
+## Installation
+You may install it to each desired Mudlet profile as follows: 
+
+1. Open your desire destination profile in Mudlet
+1. Uninstall `generic_mapper` and any other old discMapper files
+    - From Mudlet's main menu, `Toolbox` --> `Package manager`, select package, click `Uninstall`)
+1. Install and sync the discMapper module file
+    - Select `Toolbox` --> `Module manager` --> Click `Install`
+    - Navigate to `/discMapper/src` within your locally cloned branch of choice
+    - Select the `discMapper.xml` file and click `Open`
+    - Check 'sync' for the discMapper Module, and close the Module Manager
+1. Verify the discMapper triggers, aliases, and scripts are now available in Mudlet's editor
+
+## Usage
+To save any changes you make to the discMapper package from within Mudlet, **you must click the `Save Profile`
+button from within Mudlet's script editor** (__not__ the 'Save Profile As...' button).
+
+## See Also
+See the main [README](https://www.github.com/iLPdev/discMapper/README.md) for details on [discMapper](https://www.github.com/iLPdev/discMapper)
+and this repository.