memorio 2.9.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/CONTRIBUTING.md +8 -11
  2. package/README.md +430 -470
  3. package/docs/README.md +430 -470
  4. package/docs/markdown/USEOBSERVER.md +5 -3
  5. package/index.cjs +1 -1
  6. package/index.js +1 -1
  7. package/package.json +1 -9
package/CONTRIBUTING.md CHANGED
@@ -26,17 +26,15 @@ All types of contributions are encouraged and valued. See the [Table of Contents
26
26
 
27
27
  ## Code of Conduct
28
28
 
29
- This project and everyone participating in it is governed by the [memorio Code of Conduct](https://github.com/a51-dev/a51.memorio/blob/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [dariopassariello@gmail.com](mailto:dariopassariello@gmail.com).
29
+ This project and everyone participating in it is governed by the [memorio Code of Conduct](https://github.com/picla-net/picla.npm.memorio/blob/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [dariopassariello@gmail.com](mailto:dariopassariello@gmail.com).
30
30
 
31
31
  ## I Have a Question
32
32
 
33
- > If you want to ask a question, we assume that you have read the available [Documentation](https://a51.gitbook.io/memorio/).
34
-
35
- Before you ask a question, it is best to search for existing [Issues](https://github.com/a51-dev/a51.memorio/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
33
+ Before you ask a question, it is best to search for existing [Issues](https://github.com/picla-net/picla.npm.memorio/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
36
34
 
37
35
  If you then still feel the need to ask a question and need clarification, we recommend the following:
38
36
 
39
- * Open an [Issue](https://github.com/a51-dev/a51.memorio/issues/new).
37
+ * Open an [Issue](https://github.com/picla-net/picla.npm.memorio/issues/new).
40
38
  * Provide as much context as you can about what you're running into.
41
39
  * Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
42
40
 
@@ -55,8 +53,8 @@ We will then take care of the issue as soon as possible.
55
53
  A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
56
54
 
57
55
  * Make sure that you are using the latest version.
58
- * Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://a51.gitbook.io/memorio/). If you are looking for support, you might want to check [this section](contributing.md#i-have-a-question)).
59
- * To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/a51-dev/a51.memorio/issues?q=label%3Abug).
56
+ * Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment
57
+ * To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/picla-net/picla.npm.memorio/issues?q=label%3Abug).
60
58
  * Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
61
59
  * Collect information about the bug:
62
60
  * Stack trace (Traceback)
@@ -71,7 +69,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform
71
69
 
72
70
  We use GitHub issues to track bugs and errors. If you run into an issue with the project:
73
71
 
74
- * Open an [Issue](https://github.com/a51-dev/a51.memorio/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
72
+ * Open an [Issue](https://github.com/picla-net/picla.npm.memorio/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
75
73
  * Explain the behavior you would expect and the actual behavior.
76
74
  * Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
77
75
  * Provide the information you collected in the previous section.
@@ -89,13 +87,12 @@ This section guides you through submitting an enhancement suggestion for memorio
89
87
  #### Before Submitting an Enhancement
90
88
 
91
89
  * Make sure that you are using the latest version.
92
- * Read the [documentation](https://a51.gitbook.io/memorio/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
93
- * Perform a [search](https://github.com/a51-dev/a51.memorio/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
90
+ * Perform a [search](https://github.com/picla-net/picla.npm.memorio/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
94
91
  * Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
95
92
 
96
93
  #### How Do I Submit a Good Enhancement Suggestion?
97
94
 
98
- Enhancement suggestions are tracked as [GitHub issues](https://github.com/a51-dev/a51.memorio/issues).
95
+ Enhancement suggestions are tracked as [GitHub issues](https://github.com/picla-net/picla.npm.memorio/issues).
99
96
 
100
97
  * Use a **clear and descriptive title** for the issue to identify the suggestion.
101
98
  * Provide a **step-by-step description of the suggested enhancement** in as many details as possible.