@polyipseity/obsidian-plugin-library 1.6.0

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022- The obsidian-plugin-library authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,83 @@
+# Plugin Library for Obsidian [![release](https://img.shields.io/github/v/release/polyipseity/obsidian-plugin-library)][latest release]
+
+[Buy Me a Coffee]: https://buymeacoffee.com/polyipseity
+[Buy Me a Coffee/embed]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20coffee&emoji=&slug=polyipseity&button_colour=40DCA5&font_colour=ffffff&font_family=Lato&outline_colour=000000&coffee_colour=FFDD00
+[Obsidian]: https://obsidian.md/
+[changelog]: https://github.com/polyipseity/obsidian-plugin-library/blob/main/CHANGELOG.md
+[latest release]: https://github.com/polyipseity/obsidian-plugin-library/releases/latest
+[other things]: https://github.com/polyipseity/obsidian-monorepo
+[repository]: https://github.com/polyipseity/obsidian-plugin-library
+
+Library for [Obsidian] plugins.
+
+[![Buy Me a Coffee/embed]][Buy Me a Coffee]
+
+__[Repository] · [Changelog] · [Other things] · [Installation](#installation) · [Contributing](#contributing) · [Security](#security)__
+
+## Installation
+
+This is NOT an installable plugin.
+
+## Contributing
+
+Contributions are welcome!
+
+### Todos
+
+The todos here, ordered alphabetically, are things planned for the plugin. There are no guarantees that they will be completed. However, we are likely to accept contributions for them.
+
+- (None)
+
+### Translating
+
+Translation files are under [`assets/locales/`](assets/locales/). Each locale has its own directory named with its corresponding __[IETF language tag](https://wikipedia.org/wiki/IETF_language_tag)__.
+
+To contribute translation for an existing locale, modify the files in the corresponding directory.
+
+For a new locale, create a new directory named with its language tag and copy [`assets/locales/en/translation.json`](assets/locales/en/translation.json) into it. Then, add an entry to [`assets/locales/en/language.json`](assets/locales/en/language.json) in this format:
+```JSONc
+{
+	// ...
+	"en": "English",
+	"(your-language-tag)": "(Native name of your language)",
+	"uwu": "Uwuish",
+	// ...
+}
+```
+Sort the list of languages by the alphabetical order of their language tags. Then modify the files in the new directory. There will be errors in [`assets/locales.ts`](assets/locales.ts), which you can ignore and we will fix them for you. You are welcome to fix them yourself if you know TypeScript.
+
+When translating, keep in mind the following things:
+- Do not translate anything between `{{` and `}}` (`{{example}}`). They are __interpolations__ and will be replaced by localized strings at runtime.
+- Do not translate anything between `$t(` and `)` (`$t(example)`). They refer to other localized strings. To find the localized string being referred to, follow the path of the key, which is separated by dots (`.`). For example, the key [`youtu.be./dQw4w9WgXcQ`](https://youtu.be./dQw4w9WgXcQ) refers to:
+```JSONc
+{
+	// ...
+	"youtu": {
+		// ...
+		"be": {
+			// ...
+			"/dQw4w9WgXcQ": "I am 'youtu.be./dQw4w9WgXcQ'!",
+			// ...
+		},
+		// ...
+	},
+	// ...
+}
+```
+- The keys under `generic` are vocabularies. They can be referred in translation strings by `$t(generic.key)`. Refer to them as much as possible to standardize translations for vocabularies that appear in different places.
+- It is okay to move interpolations and references to other localized strings around to make the translation natural. It is also okay to not use some references used in the original translation. However, it is NOT okay to not use all interpolations.
+
+## Security
+
+We hope that there will never be any security vulnerabilities, but unfortunately it does happen. Please [report](#reporting-a-vulnerability) them!
+
+### Supported versions
+
+| Version | Supported |
+|-|-|
+| latest | ✅ |
+| outdated | ❌ |
+
+### Reporting a vulnerability
+
+Please report a vulerability by opening an new issue. We will get back to you as soon as possible.