feat: add readme for the project (#8)

README.md

@@ -1 +1,102 @@
-# replace this
+# Cdklabs Projen Project Types
+
+This repository stores custom project types extended from `projen` with cdklabs defaults
+baked in. This is meant to serve as a hook for continuous management of all repos we own.
+With cdklabs projen types, we can add new configuration as they come up and have it
+propogate to all repositories using the type.
+
+## CdklabsConstructLibrary
+
+This type extends projen's `awscdk.AwsConstructLibrary` project type and should be used in place
+of that type.
+
+### Usage
+
+From the command line:
+
+```bash
+npx projen new --from cdklabs-projen-project-types cdklabs-construct-lib
+```
+
+From inside `cdk-ops`:
+
+```ts
+this.cdklabs.addPreApprovedRepo({
+  repo: 'cdk-new-lib',
+  owner: '[email protected]',
+  createWith: {
+    projectType: ProjectType.CDKLABS_MANAGED_CONSTRUCT_LIB,
+  },
+});
+```
+
+### Features
+
+- `cdklabsPublishingDefaults`
+
+By default, this is turned on. `cdklabsPublishingDefaults` provides publishing defaults based off
+of the project's name. Specifically, the defaults look like this:
+
+```ts
+return {
+  publishToPypi: {
+    distName: npmPackageName,
+    module: changeDelimiter(npmPackageName, '_'),
+  },
+  publishToMaven: {
+    javaPackage: `io.github.cdklabs.${changeDelimiter(npmPackageName, '.')}`,
+    mavenGroupId: 'io.github.cdklabs',
+    mavenArtifactId: npmPackageName,
+    mavenEndpoint: 'https://s01.oss.sonatype.org',
+  },
+  publishToNuget: {
+    dotNetNamespace: `Cdklabs${upperCaseName(npmPackageName)}`,
+    packageId: `Cdklabs${upperCaseName(npmPackageName)}`,
+  },
+  publishToGo: {
+    moduleName: `${npmPackageName}-go`,
+  },
+};
+```
+
+Additionally, we also require that we publish to all jsii language targets (including go) when
+we specify a library as `stable`.
+
+- `private`
+
+By default, a project is created as `private`. Turning this off simply means setting `private: false`.
+A project being `private` means it gets certain properties set as default that are true for private
+projects. Today, that means setting `private: true` in `package.json`, removing `.mergify.yml` from
+the project, and removing `.npmignore`.
+
+## CdklabsTypeScriptProject
+
+This type extends projen's `typescript.TypeScriptProject` project type and should be used in place
+of that type.
+
+### Usage
+
+```bash
+npx projen new --from cdklabs-projen-project-types cdklabs-ts-proj
+```
+
+From inside `cdk-ops`:
+
+```ts
+this.cdklabs.addPreApprovedRepo({
+  repo: 'cdk-new-lib',
+  owner: '[email protected]',
+  createWith: {
+    projectType: ProjectType.CDKLABS_MANAGED_TS_PROJECT,
+  },
+});
+```
+
+### Features
+
+- `private`
+
+By default, a project is created as `private`. Turning this off simply means setting `private: false`.
+A project being `private` means it gets certain properties set as default that are true for private
+projects. Today, that means setting `private: true` in `package.json`, removing `.mergify.yml` from
+the project, and removing `.npmignore`.