@xplortech/apollo-core 0.0.6 → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+---
+
+## [0.1.0] - 2021-11-03
+
+### Added
+
+- Utility Bar Component ([#29](https://github.com/xplor/apollo/pull/29))
+- Contribution Guidelines and other community health files ([#28](https://github.com/xplor/apollo/pull/28))
+
+### Changed
+
+- Storybook stories to typescript
+
+### Fixed
+
+- Default button height (40px).
+
+## [0.0.7] - 2021-10-07
+
+### Added
+
+- Changelog file ([#27](https://github.com/xplor/apollo/pull/27))
+- PostCSS plugins `nested` and `pxtorem` ([#26](https://github.com/xplor/apollo/pull/26))
+- `stylelint`, `eslint`, and `editorconfig` ([#24](https://github.com/xplor/apollo/pull/24))
+- Tests and GitHub Action for tests ([#23](https://github.com/xplor/apollo/pull/23))
+- `release-it` and GitHub actions ([#22](https://github.com/xplor/apollo/pull/22))
+- ChoiceList and Radio components, `xpl-choicelist` and `xpl-radio` ([#20](https://github.com/xplor/apollo/pull/20), [#21](https://github.com/xplor/apollo/pull/21))
+- Avatar Component, `xpl-avatar` ([#6](https://github.com/xplor/apollo/pull/6), [#16](https://github.com/xplor/apollo/pull/16), [#18](https://github.com/xplor/apollo/pull/18), [#19](https://github.com/xplor/apollo/pull/19))
+- Markup panel (testing with button) ([#14](https://github.com/xplor/apollo/pull/14))
+- Badge component, `xpl-badge` ([#13](https://github.com/xplor/apollo/pull/13))
+- Table component, `xpl-table` ([#2](https://github.com/xplor/apollo/pull/2), [#10](https://github.com/xplor/apollo/pull/10), [#11](https://github.com/xplor/apollo/pull/11), [#12](https://github.com/xplor/apollo/pull/12), [#15](https://github.com/xplor/apollo/pull/15))
+- Button and Pagination components, `xpl-button` and `xpl-pagination` ([#8](https://github.com/xplor/apollo/pull/8), [#9](https://github.com/xplor/apollo/pull/9), [#17](https://github.com/xplor/apollo/pull/17))
+- Stencil ([#7](https://github.com/xplor/apollo/pull/7))
+- Font tokens in tailwind theme ([#5](https://github.com/xplor/apollo/pull/5))
+- Color tokens in tailwind theme ([#4](https://github.com/xplor/apollo/pull/4))
+- Tabs component, `xpl-tabs` ([#3](https://github.com/xplor/apollo/pull/3))

package/README.md

@@ -1 +1,42 @@
-# Project Apollo
+# Project Apollo 🚀
+
+Apollo is the [Xplor][xplor] UI/component framework for web products. If you design or develop web interfaces for a brand owned by Xplor, Apollo is here to make your job just a little bit easier, while making an even better product for your end users!
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Installation](#installation)
+- [Contributing](.github/CONTRIBUTING.md)
+
+## Overview
+
+Apollo is a [web component][mdn-wc] framework that uses global CSS (namespaced so that it should only style classes that start with `xpl-`). Under the hood, it uses [Stencil][stencil] to compile web components for various frameworks and [Tailwind CSS][tailwind] for style utilities.
+
+## Installation
+
+Apollo is published as a private NPM package under the Xplor organization. Before installing Apollo in your project, you need to request a token at our Slack channel `#apollo-feedback`.
+
+Create a `.npmrc` file at the root of your project with the token:
+
+```bash
+//registry.npmjs.org/:_authToken=${NPM_TOKEN}
+```
+
+Install:
+
+```bash
+npm install @xplortech/apollo-core
+```
+
+> Note: You will need to set up your NPM token in CI. [Check NPM's documentation on the topic][npm-ci-token].
+
+## Usage
+
+For more details, check [Apollo's Documentation][apollo-docs].
+
+[apollo-docs]: https://brand.xplortechnologies.com/d/xNsocmdm5dL5/web-applications#/getting-started/how-to-use
+[mdn-wc]: https://developer.mozilla.org/en-US/docs/Web/Web_Components
+[npm-ci-token]: https://docs.npmjs.com/using-private-packages-in-a-ci-cd-workflow#set-the-token-as-an-environment-variable-on-the-cicd-server
+[stencil]: https://stenciljs.com/
+[tailwind]: http://tailwindcss.com/
+[xplor]: https://www.xplortechnologies.com/