@afconsult/apollo - npm Package Compare versions

Comparing version 1.1.8 to 1.1.9

package.json

 {
   "name": "@afconsult/apollo",
-  "version": "1.1.8",
+  "version": "1.1.9",
   "description": "Design system for ÅF Web Apps",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -20,3 +20,3 @@ # Apollo Design System
 ### Example
-1. import apollo CSS in your ```src/index.js``` file:
+1. Import the stylesheet:
 ```javscript
@@ -26,3 +26,3 @@ import '@afconsult/apollo/dist/css/apollo.css';
 
-2. Import required apollo components in your ```src/index.js``` file or in any of your custom component files:
+2. Import required apollo components:
 ```javascript
@@ -32,16 +32,38 @@ import { Button, Form, FormGroup, Input, Label } from '@afconsult/apollo';
 
-3. Tell React to render the components
+3. Use the components:
 ```javascript
-ReactDOM.render(
-  <Form>
-    <FormGroup>
-      <Label for="example">Example Input</Label>
-      <Input id="example" placeholder="Inser text here..">
-    </FormGroup>
-    <Button type="submit">Submit</Button>
-  </Form>,
-  document.getElementById('app');
-)
+class Example extends React.PureComponent {
+  render() {
+    return (
+      <Form>
+        <FormGroup>
+          <Label for="example">Example Input</Label>
+          <Input id="example" placeholder="Inser text here..">
+        </FormGroup>
+        <Button type="submit">Submit</Button>
+      </Form>
+    );
+  }
+}
 ```
 
+### Components
+- [Avatar](./src/components/Avatar)
+- [Badge](./src/components/Badge)
+- [Breadcrumbs](./src/components/Breadcrumbs)
+- [Buttons](./src/components/Button)
+- [Button Group](./src/components/ButtonGroup)
+- [Collapse](./src/components/Collapse)
+- [Container](./src/components/Container)
+- [Dropdowns](./src/components/Dropdown)
+- [Follow](./src/components/Follow)
+- [Forms](./src/components/Form)
+- [Jumbotron](./src/components/Jumbotron)
+- [Loader](./src/components/Loader)
+- [Mention](./src/components/Mention)
+- [Modals](./src/components/Modal)
+- [Navs](./src/components/Nav)
+- [Navbars](./src/components/Navbar)
+- [Tag](./src/components/Tag)
+
 ## Contribute
@@ -51,2 +73,13 @@ Feel free to [create an issue or feature request](https://github.com/afconsult/apollo/issues/new).
 
+### Development
+1. Install dependencies:
+```bash
+yarn install
+```
+
+2. Run examples at `http://localhost:8080/` with webpack dev server:
+```bash
+yarn start
+```
+
 ## Authors
@@ -53,0 +86,0 @@ **Jon Wahlström** ([jonwa](https://github.com/jonwa))

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3773018

increased by0.55%

Number of package files

87

increased by40.32%

Lines of code

15367

increased by0.03%

Number of lines in readme file

88

increased by60%

No dependency changes