Merge pull request #351 from izelnakri/add-docs-to-ssr

Robert Jackson · web-flow · commit 135ec5983fec · 2021-10-05T11:14:20.000-04:00
diff --git a/packages/@glimmer/ssr/README.md b/packages/@glimmer/ssr/README.md
@@ -0,0 +1,30 @@
+# API Usage
+
+```js
+import { setComponentTemplate } from '@glimmer/core';
+import component from '@glimmer/component';
+import { renderToString } from '@glimmer/ssr';
+
+import { templateFactory } from '@glimmer/opcode-compiler';
+import { precompile } from '@glimmer/compiler';
+
+let GlimmerComponent = component.default;
+
+class PageComponent extends GlimmerComponent {}
+
+let template = `
+  {{#let "hello" "world" as |hello world|}}<p>{{hello}} {{world}}</p>{{/let}}
+`;
+
+setComponentTemplate(
+  templateFactory(JSON.parse(precompile(template, { strictMode: true }))),
+  PageComponent
+);
+
+// Print <p>hello world</p> to console:
+console.log(await renderToString(PageComponent, {
+  owner: {
+    services: {}
+  },
+}));
+```
