feat: initial commit

README.md

@@ -1,2 +1,67 @@
 # carbon-components-svelte
-Svelte implementation of the Carbon Design System
+
+> [🚧🚧🚧 UNDER CONSTRUCTION] Svelte implementation of the Carbon Design System
+
+This library is a work in progress.
+
+## Getting Started
+
+```bash
+yarn add -D carbon-components carbon-components-svelte carbon-icons-svelte
+```
+
+## Supported Components
+
+Currently, the following components are supported:
+
+- Accordion
+- AccordionItem
+- AccordionSkeleton
+- Breadcrumb
+- BreadcrumbItem
+- BreadcrumbSkeleton
+- Button
+- ButtonSkeleton
+- Checkbox
+- CheckboxSkeleton
+- CodeSnippet
+- CodeSnippetSkeleton
+- Copy
+- CopyButton
+- InlineLoading
+- Loading
+- Link
+- ListItem
+- OrderedList
+- SkeletonText
+- Tag
+- TagSkeleton
+- TextArea
+- TextAreaSkeleton
+- Toggle
+- ToggleSkeleton
+- ToggleSmall
+- ToggleSmallSkeleton
+- TooltipDefinition
+- TooltipIcon
+- UnorderedList
+
+## Usage
+
+```html
+<script>
+  import { Tag } from 'carbon-components-svelte';
+</script>
+
+<Tag>Text</Tag>
+```
+
+## Contributing
+
+[Placeholder]
+
+## [Changelog](CHANGELOG.md)
+
+## License
+
+[Apache 2.0](LICENSE)