From 572370ebc4c17a1db6284f5d51353ae7aa0ce59b Mon Sep 17 00:00:00 2001
From: Nikolai Laevskii <nikolai.laevskii@akvelon.com>
Date: Thu, 10 Aug 2023 05:52:28 +0200
Subject: [PATCH] Update readme

---
 packages/core/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/packages/core/README.md b/packages/core/README.md
index 8a471430a4..d1f38f5cde 100644
--- a/packages/core/README.md
+++ b/packages/core/README.md
@@ -333,3 +333,22 @@ toPlatformPath('/foo/bar') // => \foo\bar
 // On a Linux runner.
 toPlatformPath('\\foo\\bar') // => /foo/bar
 ```
+
+#### Platform helper
+
+Provides shorthands for getting information about platform action is running on.
+
+```js
+import { platform } from '@actions/core'
+
+platform.platform // 'win32'
+platform.arch // 'x64'
+platform.isWindows // true
+platform.isMacOS // false
+platform.isLinux // false
+
+const {
+  name, // Microsoft Windows 11 Enterprise
+  version, // 10.0.22621
+} = await platform.getInfo()
+```