@italia/avatar 0.1.0-alpha.2

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.
package/AUTHORS ADDED
@@ -0,0 +1,2 @@
1
+ Presidenza del Consiglio dei Ministri
2
+ Dipartimento per la trasformazione digitale
package/LICENSE ADDED
@@ -0,0 +1,28 @@
1
+ BSD 3-Clause License
2
+
3
+ Copyright (c) 2022, Presidenza del Consiglio dei Ministri
4
+
5
+ Redistribution and use in source and binary forms, with or without
6
+ modification, are permitted provided that the following conditions are met:
7
+
8
+ 1. Redistributions of source code must retain the above copyright notice, this
9
+ list of conditions and the following disclaimer.
10
+
11
+ 2. Redistributions in binary form must reproduce the above copyright notice,
12
+ this list of conditions and the following disclaimer in the documentation
13
+ and/or other materials provided with the distribution.
14
+
15
+ 3. Neither the name of the copyright holder nor the names of its
16
+ contributors may be used to endorse or promote products derived from
17
+ this software without specific prior written permission.
18
+
19
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package/README.md ADDED
@@ -0,0 +1,61 @@
1
+ # \<it-avatar>
2
+
3
+ This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm i @italia/avatar
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```html
14
+ <script type="module">
15
+ import '@italia/avatar/it-avatar.js';
16
+ </script>
17
+
18
+ <it-avatar></it-avatar>
19
+ ```
20
+
21
+ ## Running locally
22
+
23
+ ```bash
24
+ npm start
25
+ ```
26
+
27
+ To run a local development server that serves the basic demo located in `demo/index.html`
28
+
29
+ ## Testing
30
+
31
+ ```bash
32
+ npm run test
33
+ ```
34
+
35
+ ## Linting and formatting
36
+
37
+ To scan the project for linting and formatting errors, run
38
+
39
+ ```bash
40
+ npm run lint
41
+ ```
42
+
43
+ To automatically fix linting and formatting errors, run
44
+
45
+ ```bash
46
+ npm run format
47
+ ```
48
+
49
+ ## Tooling configs
50
+
51
+ For most of the tools, the configuration is in the `package.json` to minimize the amount of files in your project.
52
+
53
+ If you customize the configuration a lot, you can consider moving them to individual files.
54
+
55
+ ## Local Demo with `web-dev-server`
56
+
57
+ ```bash
58
+ npm start
59
+ ```
60
+
61
+ To run a local development server that serves the basic demo located in `demo/index.html`