Skip to content

Commit

Permalink
rename to library-list
Browse files Browse the repository at this point in the history
  • Loading branch information
jaeh committed May 4, 2019
1 parent c3f445d commit 4c12c65
Show file tree
Hide file tree
Showing 7 changed files with 47 additions and 47 deletions.
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## @magic-modules/client-list
## @magic-modules/library-list
this is the [@magic-modules](https://github.com/magic-modules/)
ClientList component.
LibraryList component.

shows a list of all [@magic-client](https://github.com/magic-client/) libraries.
shows a list of all [@magic-libraries](https://github.com/magic-libraries/) libraries.


[html docs](https://magic-modules.github.io/client-list/)
[html docs](https://magic-modules.github.io/library-list/)

[![NPM version][npm-image]][npm-url]
[![Linux Build Status][travis-image]][travis-url]
Expand All @@ -14,22 +14,22 @@ shows a list of all [@magic-client](https://github.com/magic-client/) libraries.
[![Greenkeeper badge][greenkeeper-image]][greenkeeper-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]

[npm-image]: https://img.shields.io/npm/v/@magic-modules/client-list.svg
[npm-url]: https://www.npmjs.com/package/@magic-modules/client-list
[travis-image]: https://api.travis-ci.org/magic-modules/client-list.svg?branch=master
[travis-url]: https://travis-ci.org/magic-modules/client-list
[appveyor-image]: https://img.shields.io/appveyor/ci/magicmodules/client-list/master.svg
[appveyor-url]: https://ci.appveyor.com/project/magicmodules/client-list/branch/master
[coveralls-image]: https://coveralls.io/repos/github/magic-modules/client-list/badge.svg
[coveralls-url]: https://coveralls.io/github/magic-modules/client-list
[greenkeeper-image]: https://badges.greenkeeper.io/magic-modules/client-list.svg
[greenkeeper-url]: https://badges.greenkeeper.io/magic-modules/client-list.svg
[snyk-image]: https://snyk.io/test/github/magic-modules/client-list/badge.svg
[snyk-url]: https://snyk.io/test/github/magic-modules/client-list
[npm-image]: https://img.shields.io/npm/v/@magic-modules/library-list.svg
[npm-url]: https://www.npmjs.com/package/@magic-modules/library-list
[travis-image]: https://api.travis-ci.org/magic-modules/library-list.svg?branch=master
[travis-url]: https://travis-ci.org/magic-modules/library-list
[appveyor-image]: https://img.shields.io/appveyor/ci/magicmodules/library-list/master.svg
[appveyor-url]: https://ci.appveyor.com/project/magicmodules/library-list/branch/master
[coveralls-image]: https://coveralls.io/repos/github/magic-modules/library-list/badge.svg
[coveralls-url]: https://coveralls.io/github/magic-modules/library-list
[greenkeeper-image]: https://badges.greenkeeper.io/magic-modules/library-list.svg
[greenkeeper-url]: https://badges.greenkeeper.io/magic-modules/library-list.svg
[snyk-image]: https://snyk.io/test/github/magic-modules/library-list/badge.svg
[snyk-url]: https://snyk.io/test/github/magic-modules/library-list

#### install:
```bash
npm install --save-exact @magic-modules/client-list
npm install --save-exact @magic-modules/library-list
```

#### usage:
Expand All @@ -41,15 +41,15 @@ npm install --save-exact @magic-modules/client-list

module.exports = {
//... other entries
ClientList = require('@magic-modules/client-list'),
LibraryList = require('@magic-modules/library-list'),
}
```

##### use tag
```javascript
// in any component view
const component = {
View: () => div([ClientList]),
View: () => div([LibraryList]),
}
```

Expand Down
2 changes: 1 addition & 1 deletion config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module.exports = {
ROOT: 'example',
WEB_ROOT: '/client-list/',
WEB_ROOT: '/library-list/',
PUBLIC: 'docs',
THEME: 'docs',
}
4 changes: 2 additions & 2 deletions example/app.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
module.exports = {
state: {
title: '@magic-modules/client-list',
title: '@magic-modules/library-list',
description: 'shows a list of all @magic-modules with gitbadges and urls to the docs',
logotext: 'ClientList',
logotext: 'LibraryList',
menu: [
{ to: '/#installation', text: 'installation' },
{ to: '/#require', text: 'require' },
Expand Down
2 changes: 1 addition & 1 deletion example/assets/index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module.exports = {
Pre: require('@magic-modules/pre'),
GitBadges: require('@magic-modules/git-badges'),
ClientList: require('../../src'),
LibraryList: require('../../src'),
}
14 changes: 7 additions & 7 deletions example/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,37 @@ module.exports = state => [
p([
'this is the ',
Link({ to: 'https://github.com/magic-modules' }, '@magic-modules'),
' ClientList component. ',
' LibraryList component. ',
state.description,
]),

GitBadges('magic-modules/client-list'),
GitBadges('magic-modules/library-list'),

h2({ id: 'installation' }, 'installation'),
Pre('npm install magic-modules/client-list'),
Pre('npm install magic-modules/library-list'),

h2({ id: 'require' }, 'require'),
p('first add the component to the assets'),
Pre(`
// assets/index.js
module.exports = {
//...other exports
ClientList: require('@magic-modules/client-list'),
LibraryList: require('@magic-modules/library-list'),
}`),

h2({ id: 'usage' }, 'usage'),
p('in a page or component'),
Pre('module.exports = () => [ClientList]'),
Pre('module.exports = () => [LibraryList]'),

h2({ id: 'demo' }, 'demo'),
p('this is what it looks like'),
ClientList,
LibraryList,

h2({ id: 'source' }, 'source'),
p([
'the source for this page is in the ',
Link(
{ to: 'https://github.com/magic-modules/client-list/tree/master/example' },
{ to: 'https://github.com/magic-modules/library-list/tree/master/example' },
'example directory',
),
' and gets built and published to github using ',
Expand Down
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"name": "@magic-modules/client-list",
"name": "@magic-modules/library-list",
"version": "0.0.1",
"author": "Wizards & Witches",
"description": "@magic-modules/client-list. displays a list of all @magic-client libraries.",
"homepage": "https://magic-modules.github.io/client-list",
"description": "@magic-modules/library-list. displays a list of all @magic-libraries libraries.",
"homepage": "https://magic-modules.github.io/library-list",
"scripts": {
"start": "t -p",
"format": "f -w --exclude docs",
Expand All @@ -19,10 +19,10 @@
],
"repository": {
"type": "git",
"url": "git+https://github.com/magic-modules/client-list.git"
"url": "git+https://github.com/magic-modules/library-list.git"
},
"bugs": {
"url": "https://github.com/magic-modules/client-list/issues"
"url": "https://github.com/magic-modules/library-list/issues"
},
"dependencies": {
"@magic-modules/git-list": "github:magic-modules/git-list"
Expand All @@ -36,7 +36,7 @@
},
"keywords": [
"magic",
"client-list"
"library-list"
],
"license": "AGPL-3.0",
"contributors": [
Expand Down
22 changes: 11 additions & 11 deletions src/index.js
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
const ClientList = props =>
CHECK_PROPS(props, ClientList.props, 'ModuleList') &&
const LibraryList = props =>
CHECK_PROPS(props, LibraryList.props, 'ModuleList') &&
GitList({
id: 'magic-client',
org: 'magic-client',
header: [Link({ to: 'https://magic-client.github.io' }, '@magic-client libraries')],
id: 'magic-libraries',
org: 'magic-libraries',
header: [Link({ to: 'https://magic-libraries.github.io' }, '@magic-libraries libraries')],
desc: ['below is a collection of the available @magic client libraries.'],
items: [
{
name: 'json',
description: [
'the @magic-client/json module parses and stringifies json.',
'the @magic-libraries/json module parses and stringifies json.',
' it also returns errors instead of throwing them.',
],
},
{
name: 'is',
description: 'the @magic-client/is module unifies the javascript type testing apis.',
description: 'the @magic-libraries/is module unifies the javascript type testing apis.',
},
{
name: 'uri',
description: [
'the @magic-client/uri module ',
'the @magic-libraries/uri module ',
' encodes objects to uri strings and decodes uri strings to objects.',
],
},
],
...props,
})

ClientList.dependencies = {
LibraryList.dependencies = {
GitList: require('@magic-modules/git-list'),
}

ClientList.props = [
LibraryList.props = [
{ key: 'id', type: 'string' },
{ key: 'org', type: 'string' },
{ key: 'header', type: 'string' },
{ key: 'desc', type: ['string', 'array'] },
{ key: 'items', type: 'array' },
]

module.exports = ClientList
module.exports = LibraryList

0 comments on commit 4c12c65

Please sign in to comment.