polygene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From paulmer...@apache.org
Subject [2/2] polygene-java git commit: :tools:generator add README and metadata to package.json
Date Mon, 15 May 2017 11:38:51 GMT
:tools:generator add README and metadata to package.json


Project: http://git-wip-us.apache.org/repos/asf/polygene-java/repo
Commit: http://git-wip-us.apache.org/repos/asf/polygene-java/commit/8f499b77
Tree: http://git-wip-us.apache.org/repos/asf/polygene-java/tree/8f499b77
Diff: http://git-wip-us.apache.org/repos/asf/polygene-java/diff/8f499b77

Branch: refs/heads/develop
Commit: 8f499b77b8b236aea764cf43e01569ba51d5fce6
Parents: 452c729
Author: Paul Merlin <paulmerlin@apache.org>
Authored: Mon May 15 13:35:55 2017 +0200
Committer: Paul Merlin <paulmerlin@apache.org>
Committed: Mon May 15 13:37:46 2017 +0200

----------------------------------------------------------------------
 tools/generator-polygene/README.md    | 47 ++++++++++++++++++++++++++++++
 tools/generator-polygene/package.json | 19 +++++++++---
 2 files changed, 62 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/polygene-java/blob/8f499b77/tools/generator-polygene/README.md
----------------------------------------------------------------------
diff --git a/tools/generator-polygene/README.md b/tools/generator-polygene/README.md
new file mode 100644
index 0000000..40f68fc
--- /dev/null
+++ b/tools/generator-polygene/README.md
@@ -0,0 +1,47 @@
+# Apache Polygene™ Project Generator
+
+
+## What is Apache Polygene™
+
+The short answer is that **Apache Polygene™** is a community based effort exploring Composite
Oriented Programming for
+domain centric application development. This includes evolved concepts from
+[Aspect Oriented Programming](https://en.wikipedia.org/wiki/Aspect-oriented_programming),
+[Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection)
+and [Domain Driven Design](https://en.wikipedia.org/wiki/Domain-driven_design).
+
+Please see [polygene.apache.org](https://polygene.apache.org) for more information.
+
+
+## How to install
+
+You will need node installed in your machine. In case you don't have it
+(you can check this typing `node --version` in your terminal) please visit this [link](https://nodejs.org/en/download/).
+
+Then run the following command:
+
+    $ npm install -g yo generator-polygene
+
+
+## Running the generator
+
+    $ yo polygene
+
+
+## Licensing
+
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/8f499b77/tools/generator-polygene/package.json
----------------------------------------------------------------------
diff --git a/tools/generator-polygene/package.json b/tools/generator-polygene/package.json
index f3141c2..3b38d85 100644
--- a/tools/generator-polygene/package.json
+++ b/tools/generator-polygene/package.json
@@ -1,19 +1,30 @@
 {
   "name": "generator-polygene",
-  "version": "3.0.0-RC0",
+  "version": "3.0.0",
   "polygene_version": "0",
   "description": "Generates an Apache Polygene project.",
+  "homepage": "https://polygene.apache.org",
+  "license": "Apache-2.0",
+  "bugs": {
+    "mail": "dev@polygene.apache.org",
+    "url": "https://issues.apache.org/jira/browse/POLYGENE"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://git-wip-us.apache.org/repos/asf/polygene-java.git"
+  },
   "scripts": {
     "test": "mocha ./test/generator_test.js --reporter mocha-junit-reporter --reporter-options
mochaFile=../../reports/tests/npmTest/generator-polygene.xml",
     "test_all": "TEST_ALL=yes mocha ./test/generator_test.js --reporter mocha-junit-reporter
--reporter-options mochaFile=../../reports/tests/npmTestAll/generator-polygene.xml"
   },
-  "files": [
-    "app"
-  ],
   "keywords": [
     "yeoman-generator",
     "apache-polygene"
   ],
+  "preferGlobal": true,
+  "files": [
+    "app"
+  ],
   "dependencies": {
     "yeoman-generator": "^0.24.1"
   },


Mime
View raw message