Skip to content

Commit a1f391b

Browse files
ulyssearulyssear
committed
README and LICENSE from old version
1 parent 33ff9e7 commit a1f391b

File tree

2 files changed

+226
-0
lines changed

2 files changed

+226
-0
lines changed

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Ulysse ARNAUD
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
<a name="readme-top"></a>
2+
3+
[![Contributors][contributors-shield]][contributors-url]
4+
[![Forks][forks-shield]][forks-url]
5+
[![Stargazers][stars-shield]][stars-url]
6+
[![Issues][issues-shield]][issues-url]
7+
[![MIT License][license-shield]][license-url]
8+
[![LinkedIn][linkedin-shield]][linkedin-url]
9+
10+
11+
12+
<!-- PROJECT LOGO -->
13+
<br />
14+
<div align="center">
15+
<a href="https://github.com/ulyssear/css-in-js-in-html">
16+
<h1 align="center">CSS in JS in HTML</h1>
17+
</a>
18+
19+
<p align="center">
20+
CSS-in-JS without CSS and JS
21+
<br />
22+
<a href="https://github.com/ulyssear/css-in-js-in-html"><strong>Explore the docs »</strong></a>
23+
<br />
24+
<br />
25+
<a href="https://github.com/ulyssear/css-in-js-in-html">View Demo</a>
26+
·
27+
<a href="https://github.com/ulyssear/css-in-js-in-html/issues">Report Bug</a>
28+
·
29+
<a href="https://github.com/ulyssear/css-in-js-in-html/issues">Request Feature</a>
30+
</p>
31+
</div>
32+
33+
34+
35+
<!-- TABLE OF CONTENTS -->
36+
<details>
37+
<summary>Table of Contents</summary>
38+
<ol>
39+
<li>
40+
<a href="#about-the-project">About The Project</a>
41+
<ul>
42+
<li><a href="#built-with">Built With</a></li>
43+
</ul>
44+
</li>
45+
<li>
46+
<a href="#getting-started">Getting Started</a>
47+
<ul>
48+
<li><a href="#prerequisites">Prerequisites</a></li>
49+
<li><a href="#installation">Installation</a></li>
50+
</ul>
51+
</li>
52+
<li><a href="#usage">Usage</a></li>
53+
<li><a href="#roadmap">Roadmap</a></li>
54+
<li><a href="#contributing">Contributing</a></li>
55+
<li><a href="#license">License</a></li>
56+
<li><a href="#contact">Contact</a></li>
57+
<!-- <li><a href="#acknowledgments">Acknowledgments</a></li> -->
58+
</ol>
59+
</details>
60+
61+
62+
63+
<!-- ABOUT THE PROJECT -->
64+
## About The Project
65+
66+
<!-- TODO : ADD dynamic examples -->
67+
68+
CSS-in-JS-in-HTML is a JavaScript library which permits you to apply CSS properties with also some useful features to design your dynamic HTML elements.
69+
70+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
71+
72+
73+
74+
### Built With
75+
76+
[![Javascript][Javascript-shield]][Javascript-url]
77+
78+
79+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
80+
81+
82+
83+
<!-- GETTING STARTED -->
84+
## Getting Started
85+
86+
87+
88+
### Prerequisites
89+
90+
91+
92+
### Installation
93+
94+
#### From CDN
95+
96+
1. Import `index.min.js` (or `index.js`) in your HTML file
97+
```html
98+
<script src="https://cdn.jsdelivr.net/gh/ulyssear/css-in-js-in-html/index.min.js"></script>
99+
```
100+
101+
#### Manual installation
102+
103+
1. Clone the repo
104+
```sh
105+
git clone https://github.com/ulyssear/css-in-js-in-html.git
106+
```
107+
2. Import `index.min.js` (or `index.js`) in your HTML file
108+
```html
109+
<script src="path/to/css-in-js-in-html/index.min.js"></script>
110+
```
111+
112+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
113+
114+
115+
116+
<!-- USAGE EXAMPLES -->
117+
## Usage
118+
119+
<!-- TODO : ADD examples -->
120+
121+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
122+
123+
124+
125+
<!-- ROADMAP -->
126+
## Roadmap
127+
128+
<!-- TODO : ADD roadmap
129+
- [ ] Feature 1
130+
- [ ] Feature 2
131+
- [ ] Feature 3
132+
- [ ] Nested Feature
133+
-->
134+
See the [open issues](https://github.com/ulyssear/css-in-js-in-html/issues) for a full list of proposed features (and known issues).
135+
136+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
137+
138+
139+
140+
<!-- CONTRIBUTING -->
141+
## Contributing
142+
143+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
144+
145+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
146+
Don't forget to give the project a star! Thanks again!
147+
148+
1. Fork the Project
149+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
150+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
151+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
152+
5. Open a Pull Request
153+
154+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
155+
156+
157+
158+
<!-- LICENSE -->
159+
## License
160+
161+
Distributed under the MIT License. See `LICENSE` for more information.
162+
163+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
164+
165+
166+
167+
<!-- CONTACT -->
168+
## Contact
169+
170+
Ulysse ARNAUD - ulysse@arnaud.tech
171+
172+
Project Link: [https://github.com/ulyssear/css-in-js-in-html](https://github.com/ulyssear/css-in-js-in-html)
173+
174+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
175+
176+
177+
178+
<!-- TODO : ACKNOWLEDGMENTS ?
179+
## Acknowledgments
180+
181+
* []()
182+
* []()
183+
* []()
184+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
185+
186+
-->
187+
188+
189+
<!-- MARKDOWN LINKS & IMAGES -->
190+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
191+
[contributors-shield]: https://img.shields.io/github/contributors/ulyssear/css-in-js-in-html.svg?style=for-the-badge
192+
[contributors-url]: https://github.com/ulyssear/css-in-js-in-html/graphs/contributors
193+
[forks-shield]: https://img.shields.io/github/forks/ulyssear/css-in-js-in-html.svg?style=for-the-badge
194+
[forks-url]: https://github.com/ulyssear/css-in-js-in-html/network/members
195+
[stars-shield]: https://img.shields.io/github/stars/ulyssear/css-in-js-in-html.svg?style=for-the-badge
196+
[stars-url]: https://github.com/ulyssear/css-in-js-in-html/stargazers
197+
[issues-shield]: https://img.shields.io/github/issues/ulyssear/css-in-js-in-html.svg?style=for-the-badge
198+
[issues-url]: https://github.com/ulyssear/css-in-js-in-html/issues
199+
[license-shield]: https://img.shields.io/github/license/ulyssear/css-in-js-in-html.svg?style=for-the-badge
200+
[license-url]: https://github.com/ulyssear/css-in-js-in-html/blob/master/LICENSE
201+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
202+
[linkedin-url]: https://linkedin.com/in/ulyssearnaud
203+
[product-screenshot]: images/screenshot.png
204+
[JavaScript-shield]: https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E
205+
[JavaScript-url]: https://www.javascript.com/

0 commit comments

Comments
 (0)