Merge pull request #12 from alexdln/nc-11

nc-11 refactor package and example

Author: alexdln

.github/workflows/auto-tests.yml

@@ -3,24 +3,23 @@ name: Test package
 on:
   schedule:
     - cron: "0 */6 * * *"
+  workflow_dispatch:
 
 jobs:
   test:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v6
         with:
-          node-version: "20"
+          node-version: "24"
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v3
-        with:
-          version: 8
+        uses: pnpm/action-setup@v4
 
       - name: Install dependencies and build package
         run: |

.github/workflows/npm-publish.yml

@@ -10,17 +10,15 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v6
         with:
-          node-version: '20'
+          node-version: "24"
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v3
-        with:
-          version: 8
+        uses: pnpm/action-setup@v4
 
       - name: Install dependencies and build
         run: |
@@ -42,6 +40,7 @@ jobs:
         if: "!contains(github.ref_name, 'canary')"
         run: |
           npm set //registry.npmjs.org/:_authToken=${{secrets.NPM_TOKEN}}
+          npm version --no-git-tag-version ${{github.ref_name}}
           npm publish --access public
         working-directory: ./package
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Alexander Savelyev <vordgi1@gmail.com>
+Copyright (c) 2025 Alex Savelyev <dev@alexdln.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -20,6 +20,37 @@ npm i @nimpl/context
 yarn add @nimpl/context
 ```
 
+## Usage
+
+```tsx
+// stores/app-store/contexts.server.tsx
+import createServerContext from "@nimpl/context/create-server-context";
+export const AppServerContext = createServerContext<{ data: string | null }>({
+  data: null,
+});
+
+// components/parent-component
+import { AppServerContext } from "@/stores/app-store/contexts.server";
+import { ChildComponent } from "./child-component";
+
+export const ParentComponent = () => (
+  {/* Same as <AppServerContext.Provider /> */}
+  <AppServerContext value={{ data: "test" }}>
+    <ChildComponent />
+  </AppServerContext>
+);
+
+// components/child-component
+import getServerContext from "@nimpl/context/get-server-context";
+import { AppServerContext } from "@/stores/app-store/contexts.server";
+
+export const ChildComponent = () => {
+  const context = getServerContext(AppServerContext);
+
+  return <div>{context.data}</div>;
+};
+```
+
 ## Stability
 
 All context are covered with tests. Tests are run on every release and every 6 hours on the latest **Canary** version of `Next.js`.
@@ -28,7 +59,7 @@ In this way, you can be sure not only of the stability of the code, but also tha
 
 ## Examples
 
-You can see examples in the [directory](https://github.com/vordgi/nimpl-context/tree/main/examples) of the repository.
+You can see examples in the [directory](https://github.com/alexdln/nimpl-context/tree/main/examples) of the repository.
 
 ## Additional
 
@@ -38,4 +69,4 @@ Create issues for identified issues, desired getters, or various improvements.
 
 ## License
 
-[MIT](https://github.com/vordgi/nimpl-context/blob/main/LICENSE)
+[MIT](https://github.com/alexdln/nimpl-context/blob/main/LICENSE)