edit readme

Author: boristane

.github/workflows/publish.yml

@@ -95,40 +95,40 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-  # notify-community:
-  #   needs: [create-release]
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - name: Checkout
-  #       uses: actions/checkout@v2
-  #     - name: Get version from tag
-  #       id: tag_name
-  #       run: |
-  #         echo ::set-output name=current_version::${GITHUB_REF#refs/tags/v}
-  #     - name: Post to the community Slack channel
-  #       uses: slackapi/[email protected]
-  #       with:
-  #         channel-id: 'C04KT9JNRHS'
-  #         payload: |
-  #           {
-  #             "text": "[Release] Baselime Lambda Opentelemetry for Node.JS v${{ steps.tag_name.outputs.current_version }}",
-  #             "blocks": [
-  #               {
-  #                 "type": "section",
-  #                 "text": {
-  #                   "type": "mrkdwn",
-  #                   "text": "*[Release] Baselime Lambda Opentelemetry for Node.JS v${{ steps.tag_name.outputs.current_version }}*"
-  #                 }
-  #               },
-  #               {
-  #                 "type": "section",
-  #                 "text": {
-  #                   "type": "mrkdwn",
-  #                   "text": "<https://github.com/Baselime/lambda-node-opentelemetry/releases/tag/v${{ steps.tag_name.outputs.current_version }}|https://github.com/Baselime/lambda-node-opentelemetry/releases/tag/v${{ steps.tag_name.outputs.current_version }}>"
-  #                 }
-  #               }
-  #             ]
-  #           }
-  #       env:
-  #         SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
+  notify-community:
+    needs: [create-release]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Get version from tag
+        id: tag_name
+        run: |
+          echo ::set-output name=current_version::${GITHUB_REF#refs/tags/v}
+      - name: Post to the community Slack channel
+        uses: slackapi/[email protected]
+        with:
+          channel-id: 'C04KT9JNRHS'
+          payload: |
+            {
+              "text": "[Release] Baselime Opentelemetry for Node.JS Lambda v${{ steps.tag_name.outputs.current_version }}",
+              "blocks": [
+                {
+                  "type": "section",
+                  "text": {
+                    "type": "mrkdwn",
+                    "text": "*[Release] Baselime Opentelemetry for Node.JS Lambda v${{ steps.tag_name.outputs.current_version }}*"
+                  }
+                },
+                {
+                  "type": "section",
+                  "text": {
+                    "type": "mrkdwn",
+                    "text": "<https://github.com/Baselime/lambda-node-opentelemetry/releases/tag/v${{ steps.tag_name.outputs.current_version }}|https://github.com/Baselime/lambda-node-opentelemetry/releases/tag/v${{ steps.tag_name.outputs.current_version }}>"
+                  }
+                }
+              ]
+            }
+        env:
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
 

ManualInstrumentation.md

@@ -3,15 +3,20 @@
 [![Latest Release][release_badge]][release]
 [![License][license_badge]][license]
 
-The `@baselime/lambda-node-opentelemetry` package instruments your lambda functions and automatically ships OTEL compatible trace data to Baselime. This is the most powerful and flexible way to instrument your node service.
+The `@baselime/lambda-node-opentelemetry` package instruments your Node.js AWS Lambda functions with OpenTelemetry and automatically sends tracing data to Baselime. This is the most powerful and flexible way to instrument your serverless functions.
 
 ![Trace Timeline](trace-timeline.png)
 
-This can be applied completely automatically to your lambda functions using our automatic instrumentation.
+## Installation
+
+### Automatic Installation
 
-To enroll a lambda tag it with `baselime:tracing` `true`
+Once you've connected your AWS account to Baselime, add the `baselime:tracing` tag to any of your Node.js AWS Lambda functions and it will be automatically instrumented with OpenTelemetry.
 
-If you would rather instrument the lambda manually follow this [guide](./ManualInstrumentation)
+### Manual Installation
+
+To manually install this instrumentation, follow the steps in our [docs](https://baselime.io/docs/sending-data/opentelemetry/aws-lambda/node.js/).
+This can be applied completely automatically to your lambda functions using our automatic instrumentation.
 
 ## License